From a3abcb888c0978dfb43acd2bb68e5cca3cd28b69 Mon Sep 17 00:00:00 2001 From: nojaf Date: Sat, 2 Nov 2024 19:53:26 +0000 Subject: [PATCH] deploy: c84184ee1d011b8fbbe237f4adb12bff702cf5e6 --- .nojekyll | 0 Dockerfile | 29 + NuGet.config | 14 + README.txt | 16 + apidocs.fsx | 416 +++ apidocs.html | 795 +++++ apidocs.ipynb | 726 ++++ apidocs.md | 424 +++ apidocs.tex | 609 ++++ codeformat.fsx | 138 + codeformat.html | 528 +++ codeformat.ipynb | 318 ++ codeformat.md | 139 + codeformat.tex | 228 ++ commandline.fsx | 112 + commandline.html | 518 +++ commandline.ipynb | 149 + commandline.md | 110 + commandline.tex | 183 + content.fsx | 232 ++ content.html | 632 ++++ content.ipynb | 290 ++ content.md | 245 ++ content.tex | 375 ++ content/fsdocs-default.css | 1288 +++++++ content/fsdocs-details-set-expanded.js | 9 + content/fsdocs-details-toggle.js | 46 + content/fsdocs-search.js | 126 + content/fsdocs-theme-set-dark.js | 5 + content/fsdocs-theme-toggle.js | 38 + content/fsdocs-theme.css | 1 + content/fsdocs-theme.js | 35 + content/fsdocs-tips.js | 59 + content/img/github-pages-settings.png | Bin 0 -> 33534 bytes evaluation.fsx | 188 + evaluation.html | 571 +++ evaluation.ipynb | 347 ++ evaluation.md | 205 ++ evaluation.tex | 318 ++ img/badge-binder.svg | 1 + img/badge-notebook.svg | 1 + img/badge-script.svg | 1 + img/favicon.ico | Bin 0 -> 15086 bytes img/logo.pdn | Bin 0 -> 23734 bytes img/logo.png | Bin 0 -> 9010 bytes index.fsx | 63 + index.html | 382 ++ index.ipynb | 100 + index.json | 1 + index.md | 61 + index.tex | 134 + literate-notebook.fsx | 53 + literate-notebook.html | 376 ++ literate-notebook.ipynb | 118 + literate-notebook.md | 52 + literate-notebook.tex | 106 + literate.fsx | 271 ++ literate.html | 759 ++++ literate.ipynb | 413 +++ literate.md | 268 ++ literate.tex | 392 ++ markdown.fsx | 154 + markdown.html | 528 +++ markdown.ipynb | 338 ++ markdown.md | 154 + markdown.tex | 247 ++ ...rp-formatting-apidocs-apidocattribute.html | 1298 +++++++ ...p-formatting-apidocs-apidoccollection.html | 672 ++++ ...harp-formatting-apidocs-apidoccomment.html | 1134 ++++++ ...sharp-formatting-apidocs-apidocentity.html | 3115 ++++++++++++++++ ...p-formatting-apidocs-apidocentityinfo.html | 749 ++++ ...rmatting-apidocs-apidocfileextensions.html | 474 +++ .../fsharp-formatting-apidocs-apidochtml.html | 595 ++++ ...fsharp-formatting-apidocs-apidocinput.html | 1007 ++++++ ...sharp-formatting-apidocs-apidocmember.html | 2441 +++++++++++++ ...ormatting-apidocs-apidocmemberdetails.html | 542 +++ ...p-formatting-apidocs-apidocmemberkind.html | 827 +++++ ...fsharp-formatting-apidocs-apidocmodel.html | 982 +++++ ...rp-formatting-apidocs-apidocnamespace.html | 1117 ++++++ .../fsharp-formatting-apidocs-apidocs.html | 1365 +++++++ ...tting-apidocs-apidocssearchindexentry.html | 621 ++++ .../fsharp-formatting-apidocs-apidoctype.html | 342 ++ .../fsharp-formatting-apidocs-attribute.html | 342 ++ .../fsharp-formatting-apidocs-doccomment.html | 342 ++ .../fsharp-formatting-apidocs-member.html | 342 ++ .../fsharp-formatting-apidocs-memberkind.html | 342 ++ .../fsharp-formatting-apidocs-module.html | 342 ++ .../fsharp-formatting-apidocs-moduleinfo.html | 342 ++ reference/fsharp-formatting-apidocs-type.html | 342 ++ .../fsharp-formatting-apidocs-typeinfo.html | 342 ++ reference/fsharp-formatting-apidocs.html | 806 +++++ ...harp-formatting-codeformat-codeformat.html | 797 +++++ ...p-formatting-codeformat-codeformatter.html | 1092 ++++++ ...sharp-formatting-codeformat-errorkind.html | 459 +++ ...ormatting-codeformat-formattedcontent.html | 595 ++++ ...ormatting-codeformat-formattedsnippet.html | 658 ++++ .../fsharp-formatting-codeformat-line.html | 453 +++ .../fsharp-formatting-codeformat-snippet.html | 452 +++ ...arp-formatting-codeformat-sourceerror.html | 496 +++ ...sharp-formatting-codeformat-tokenkind.html | 1273 +++++++ ...sharp-formatting-codeformat-tokenspan.html | 680 ++++ ...harp-formatting-codeformat-tokenspans.html | 709 ++++ ...arp-formatting-codeformat-tooltipspan.html | 527 +++ ...rp-formatting-codeformat-tooltipspans.html | 709 ++++ reference/fsharp-formatting-codeformat.html | 747 ++++ ...sharp-formatting-common-menu-menuitem.html | 526 +++ reference/fsharp-formatting-common-menu.html | 668 ++++ ...arp-formatting-common-pagecontentlist.html | 497 +++ reference/fsharp-formatting-common.html | 395 ++ ...p-formatting-csharpformat-clikeformat.html | 554 +++ ...rp-formatting-csharpformat-codeformat.html | 886 +++++ ...rmatting-csharpformat-cplusplusformat.html | 551 +++ ...-formatting-csharpformat-csharpformat.html | 612 ++++ ...-formatting-csharpformat-fsharpformat.html | 735 ++++ ...formatting-csharpformat-haskellformat.html | 673 ++++ ...rp-formatting-csharpformat-htmlformat.html | 414 +++ ...matting-csharpformat-javascriptformat.html | 612 ++++ ...arp-formatting-csharpformat-mshformat.html | 673 ++++ ...p-formatting-csharpformat-paketformat.html | 675 ++++ ...arp-formatting-csharpformat-phpformat.html | 612 ++++ ...-formatting-csharpformat-sourceformat.html | 1154 ++++++ ...atting-csharpformat-syntaxhighlighter.html | 605 ++++ ...rp-formatting-csharpformat-tsqlformat.html | 737 ++++ ...matting-csharpformat-typescriptformat.html | 490 +++ ...atting-csharpformat-visualbasicformat.html | 736 ++++ reference/fsharp-formatting-csharpformat.html | 839 +++++ ...ting-literate-evaluation-fsiembedkind.html | 609 ++++ ...te-evaluation-fsievaluationfailedinfo.html | 607 ++++ ...terate-evaluation-fsievaluationresult.html | 609 ++++ ...ting-literate-evaluation-fsievaluator.html | 673 ++++ ...iterate-evaluation-fsievaluatorconfig.html | 498 +++ ...erate-evaluation-ifsievaluationresult.html | 347 ++ ...ing-literate-evaluation-ifsievaluator.html | 610 ++++ ...fsharp-formatting-literate-evaluation.html | 559 +++ .../fsharp-formatting-literate-indextext.html | 452 +++ .../fsharp-formatting-literate-literate.html | 3173 +++++++++++++++++ ...rmatting-literate-literatecodeoptions.html | 610 ++++ ...tting-literate-literatecodevisibility.html | 519 +++ ...-formatting-literate-literatedocument.html | 1221 +++++++ ...formatting-literate-literateparagraph.html | 1280 +++++++ ...ing-literate-literateparagraphoptions.html | 437 +++ ...rp-formatting-literate-literatesource.html | 508 +++ ...-formatting-literate-markdownpatterns.html | 437 +++ ...fsharp-formatting-literate-outputkind.html | 635 ++++ reference/fsharp-formatting-literate.html | 664 ++++ reference/fsharp-formatting-markdown-dsl.html | 1382 +++++++ ...rp-formatting-markdown-htmlformatting.html | 565 +++ .../fsharp-formatting-markdown-markdown.html | 2167 +++++++++++ ...ting-markdown-markdowncolumnalignment.html | 533 +++ ...-formatting-markdown-markdowndocument.html | 598 ++++ ...ting-markdown-markdownembedparagraphs.html | 424 +++ ...ormatting-markdown-markdownembedspans.html | 424 +++ ...-formatting-markdown-markdownlistkind.html | 461 +++ ...formatting-markdown-markdownparagraph.html | 1642 +++++++++ ...ormatting-markdown-markdownparagraphs.html | 709 ++++ ...matting-markdown-markdownparseoptions.html | 582 +++ ...wn-markdownpatterns-paragraphleafinfo.html | 354 ++ ...-markdownpatterns-paragraphnestedinfo.html | 354 ++ ...n-markdownpatterns-paragraphspansinfo.html | 354 ++ ...arkdown-markdownpatterns-spanleafinfo.html | 354 ++ ...arkdown-markdownpatterns-spannodeinfo.html | 354 ++ ...-formatting-markdown-markdownpatterns.html | 1084 ++++++ ...arp-formatting-markdown-markdownrange.html | 569 +++ ...rmatting-markdown-markdownrangemodule.html | 480 +++ ...harp-formatting-markdown-markdownspan.html | 1399 ++++++++ ...arp-formatting-markdown-markdownspans.html | 709 ++++ ...-formatting-markdown-markdowntablerow.html | 709 ++++ reference/fsharp-formatting-markdown.html | 876 +++++ ...formatting-templating-frontmatterfile.html | 685 ++++ ...fsharp-formatting-templating-paramkey.html | 441 +++ ...sharp-formatting-templating-paramkeys.html | 3056 ++++++++++++++++ ...p-formatting-templating-substitutions.html | 709 ++++ reference/fsharp-formatting-templating.html | 464 +++ reference/index.html | 413 +++ sidebyside/sideextensions.fsx | 43 + sidebyside/sideextensions.html | 350 ++ sidebyside/sideextensions.ipynb | 80 + sidebyside/sideextensions.md | 41 + sidebyside/sideextensions.tex | 100 + sidebyside/sidemarkdown.fsx | 66 + sidebyside/sidemarkdown.html | 389 ++ sidebyside/sidemarkdown.ipynb | 103 + sidebyside/sidemarkdown.md | 64 + sidebyside/sidemarkdown.tex | 131 + sidebyside/sidescript.fsx | 68 + sidebyside/sidescript.html | 391 ++ sidebyside/sidescript.ipynb | 189 + sidebyside/sidescript.md | 70 + sidebyside/sidescript.tex | 143 + styling.fsx | 212 ++ styling.html | 653 ++++ styling.ipynb | 249 ++ styling.md | 210 ++ styling.tex | 302 ++ templates/leftside/styling.fsx | 29 + templates/leftside/styling.html | 343 ++ templates/leftside/styling.ipynb | 89 + templates/leftside/styling.md | 27 + templates/leftside/styling.tex | 77 + upgrade.fsx | 83 + upgrade.html | 383 ++ upgrade.ipynb | 120 + upgrade.md | 81 + upgrade.tex | 143 + users.fsx | 35 + users.html | 438 +++ users.ipynb | 95 + users.md | 33 + users.tex | 83 + zero-to-hero.fsx | 267 ++ zero-to-hero.html | 566 +++ zero-to-hero.ipynb | 304 ++ zero-to-hero.md | 265 ++ zero-to-hero.tex | 392 ++ 214 files changed, 104555 insertions(+) create mode 100644 .nojekyll create mode 100644 Dockerfile create mode 100644 NuGet.config create mode 100644 README.txt create mode 100644 apidocs.fsx create mode 100644 apidocs.html create mode 100644 apidocs.ipynb create mode 100644 apidocs.md create mode 100644 apidocs.tex create mode 100644 codeformat.fsx create mode 100644 codeformat.html create mode 100644 codeformat.ipynb create mode 100644 codeformat.md create mode 100644 codeformat.tex create mode 100644 commandline.fsx create mode 100644 commandline.html create mode 100644 commandline.ipynb create mode 100644 commandline.md create mode 100644 commandline.tex create mode 100644 content.fsx create mode 100644 content.html create mode 100644 content.ipynb create mode 100644 content.md create mode 100644 content.tex create mode 100644 content/fsdocs-default.css create mode 100644 content/fsdocs-details-set-expanded.js create mode 100644 content/fsdocs-details-toggle.js create mode 100644 content/fsdocs-search.js create mode 100644 content/fsdocs-theme-set-dark.js create mode 100644 content/fsdocs-theme-toggle.js create mode 100644 content/fsdocs-theme.css create mode 100644 content/fsdocs-theme.js create mode 100644 content/fsdocs-tips.js create mode 100644 content/img/github-pages-settings.png create mode 100644 evaluation.fsx create mode 100644 evaluation.html create mode 100644 evaluation.ipynb create mode 100644 evaluation.md create mode 100644 evaluation.tex create mode 100644 img/badge-binder.svg create mode 100644 img/badge-notebook.svg create mode 100644 img/badge-script.svg create mode 100644 img/favicon.ico create mode 100644 img/logo.pdn create mode 100644 img/logo.png create mode 100644 index.fsx create mode 100644 index.html create mode 100644 index.ipynb create mode 100644 index.json create mode 100644 index.md create mode 100644 index.tex create mode 100644 literate-notebook.fsx create mode 100644 literate-notebook.html create mode 100644 literate-notebook.ipynb create mode 100644 literate-notebook.md create mode 100644 literate-notebook.tex create mode 100644 literate.fsx create mode 100644 literate.html create mode 100644 literate.ipynb create mode 100644 literate.md create mode 100644 literate.tex create mode 100644 markdown.fsx create mode 100644 markdown.html create mode 100644 markdown.ipynb create mode 100644 markdown.md create mode 100644 markdown.tex create mode 100644 reference/fsharp-formatting-apidocs-apidocattribute.html create mode 100644 reference/fsharp-formatting-apidocs-apidoccollection.html create mode 100644 reference/fsharp-formatting-apidocs-apidoccomment.html create mode 100644 reference/fsharp-formatting-apidocs-apidocentity.html create mode 100644 reference/fsharp-formatting-apidocs-apidocentityinfo.html create mode 100644 reference/fsharp-formatting-apidocs-apidocfileextensions.html create mode 100644 reference/fsharp-formatting-apidocs-apidochtml.html create mode 100644 reference/fsharp-formatting-apidocs-apidocinput.html create mode 100644 reference/fsharp-formatting-apidocs-apidocmember.html create mode 100644 reference/fsharp-formatting-apidocs-apidocmemberdetails.html create mode 100644 reference/fsharp-formatting-apidocs-apidocmemberkind.html create mode 100644 reference/fsharp-formatting-apidocs-apidocmodel.html create mode 100644 reference/fsharp-formatting-apidocs-apidocnamespace.html create mode 100644 reference/fsharp-formatting-apidocs-apidocs.html create mode 100644 reference/fsharp-formatting-apidocs-apidocssearchindexentry.html create mode 100644 reference/fsharp-formatting-apidocs-apidoctype.html create mode 100644 reference/fsharp-formatting-apidocs-attribute.html create mode 100644 reference/fsharp-formatting-apidocs-doccomment.html create mode 100644 reference/fsharp-formatting-apidocs-member.html create mode 100644 reference/fsharp-formatting-apidocs-memberkind.html create mode 100644 reference/fsharp-formatting-apidocs-module.html create mode 100644 reference/fsharp-formatting-apidocs-moduleinfo.html create mode 100644 reference/fsharp-formatting-apidocs-type.html create mode 100644 reference/fsharp-formatting-apidocs-typeinfo.html create mode 100644 reference/fsharp-formatting-apidocs.html create mode 100644 reference/fsharp-formatting-codeformat-codeformat.html create mode 100644 reference/fsharp-formatting-codeformat-codeformatter.html create mode 100644 reference/fsharp-formatting-codeformat-errorkind.html create mode 100644 reference/fsharp-formatting-codeformat-formattedcontent.html create mode 100644 reference/fsharp-formatting-codeformat-formattedsnippet.html create mode 100644 reference/fsharp-formatting-codeformat-line.html create mode 100644 reference/fsharp-formatting-codeformat-snippet.html create mode 100644 reference/fsharp-formatting-codeformat-sourceerror.html create mode 100644 reference/fsharp-formatting-codeformat-tokenkind.html create mode 100644 reference/fsharp-formatting-codeformat-tokenspan.html create mode 100644 reference/fsharp-formatting-codeformat-tokenspans.html create mode 100644 reference/fsharp-formatting-codeformat-tooltipspan.html create mode 100644 reference/fsharp-formatting-codeformat-tooltipspans.html create mode 100644 reference/fsharp-formatting-codeformat.html create mode 100644 reference/fsharp-formatting-common-menu-menuitem.html create mode 100644 reference/fsharp-formatting-common-menu.html create mode 100644 reference/fsharp-formatting-common-pagecontentlist.html create mode 100644 reference/fsharp-formatting-common.html create mode 100644 reference/fsharp-formatting-csharpformat-clikeformat.html create mode 100644 reference/fsharp-formatting-csharpformat-codeformat.html create mode 100644 reference/fsharp-formatting-csharpformat-cplusplusformat.html create mode 100644 reference/fsharp-formatting-csharpformat-csharpformat.html create mode 100644 reference/fsharp-formatting-csharpformat-fsharpformat.html create mode 100644 reference/fsharp-formatting-csharpformat-haskellformat.html create mode 100644 reference/fsharp-formatting-csharpformat-htmlformat.html create mode 100644 reference/fsharp-formatting-csharpformat-javascriptformat.html create mode 100644 reference/fsharp-formatting-csharpformat-mshformat.html create mode 100644 reference/fsharp-formatting-csharpformat-paketformat.html create mode 100644 reference/fsharp-formatting-csharpformat-phpformat.html create mode 100644 reference/fsharp-formatting-csharpformat-sourceformat.html create mode 100644 reference/fsharp-formatting-csharpformat-syntaxhighlighter.html create mode 100644 reference/fsharp-formatting-csharpformat-tsqlformat.html create mode 100644 reference/fsharp-formatting-csharpformat-typescriptformat.html create mode 100644 reference/fsharp-formatting-csharpformat-visualbasicformat.html create mode 100644 reference/fsharp-formatting-csharpformat.html create mode 100644 reference/fsharp-formatting-literate-evaluation-fsiembedkind.html create mode 100644 reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html create mode 100644 reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html create mode 100644 reference/fsharp-formatting-literate-evaluation-fsievaluator.html create mode 100644 reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html create mode 100644 reference/fsharp-formatting-literate-evaluation-ifsievaluationresult.html create mode 100644 reference/fsharp-formatting-literate-evaluation-ifsievaluator.html create mode 100644 reference/fsharp-formatting-literate-evaluation.html create mode 100644 reference/fsharp-formatting-literate-indextext.html create mode 100644 reference/fsharp-formatting-literate-literate.html create mode 100644 reference/fsharp-formatting-literate-literatecodeoptions.html create mode 100644 reference/fsharp-formatting-literate-literatecodevisibility.html create mode 100644 reference/fsharp-formatting-literate-literatedocument.html create mode 100644 reference/fsharp-formatting-literate-literateparagraph.html create mode 100644 reference/fsharp-formatting-literate-literateparagraphoptions.html create mode 100644 reference/fsharp-formatting-literate-literatesource.html create mode 100644 reference/fsharp-formatting-literate-markdownpatterns.html create mode 100644 reference/fsharp-formatting-literate-outputkind.html create mode 100644 reference/fsharp-formatting-literate.html create mode 100644 reference/fsharp-formatting-markdown-dsl.html create mode 100644 reference/fsharp-formatting-markdown-htmlformatting.html create mode 100644 reference/fsharp-formatting-markdown-markdown.html create mode 100644 reference/fsharp-formatting-markdown-markdowncolumnalignment.html create mode 100644 reference/fsharp-formatting-markdown-markdowndocument.html create mode 100644 reference/fsharp-formatting-markdown-markdownembedparagraphs.html create mode 100644 reference/fsharp-formatting-markdown-markdownembedspans.html create mode 100644 reference/fsharp-formatting-markdown-markdownlistkind.html create mode 100644 reference/fsharp-formatting-markdown-markdownparagraph.html create mode 100644 reference/fsharp-formatting-markdown-markdownparagraphs.html create mode 100644 reference/fsharp-formatting-markdown-markdownparseoptions.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns-paragraphleafinfo.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns-paragraphnestedinfo.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns-paragraphspansinfo.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns-spanleafinfo.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns-spannodeinfo.html create mode 100644 reference/fsharp-formatting-markdown-markdownpatterns.html create mode 100644 reference/fsharp-formatting-markdown-markdownrange.html create mode 100644 reference/fsharp-formatting-markdown-markdownrangemodule.html create mode 100644 reference/fsharp-formatting-markdown-markdownspan.html create mode 100644 reference/fsharp-formatting-markdown-markdownspans.html create mode 100644 reference/fsharp-formatting-markdown-markdowntablerow.html create mode 100644 reference/fsharp-formatting-markdown.html create mode 100644 reference/fsharp-formatting-templating-frontmatterfile.html create mode 100644 reference/fsharp-formatting-templating-paramkey.html create mode 100644 reference/fsharp-formatting-templating-paramkeys.html create mode 100644 reference/fsharp-formatting-templating-substitutions.html create mode 100644 reference/fsharp-formatting-templating.html create mode 100644 reference/index.html create mode 100644 sidebyside/sideextensions.fsx create mode 100644 sidebyside/sideextensions.html create mode 100644 sidebyside/sideextensions.ipynb create mode 100644 sidebyside/sideextensions.md create mode 100644 sidebyside/sideextensions.tex create mode 100644 sidebyside/sidemarkdown.fsx create mode 100644 sidebyside/sidemarkdown.html create mode 100644 sidebyside/sidemarkdown.ipynb create mode 100644 sidebyside/sidemarkdown.md create mode 100644 sidebyside/sidemarkdown.tex create mode 100644 sidebyside/sidescript.fsx create mode 100644 sidebyside/sidescript.html create mode 100644 sidebyside/sidescript.ipynb create mode 100644 sidebyside/sidescript.md create mode 100644 sidebyside/sidescript.tex create mode 100644 styling.fsx create mode 100644 styling.html create mode 100644 styling.ipynb create mode 100644 styling.md create mode 100644 styling.tex create mode 100644 templates/leftside/styling.fsx create mode 100644 templates/leftside/styling.html create mode 100644 templates/leftside/styling.ipynb create mode 100644 templates/leftside/styling.md create mode 100644 templates/leftside/styling.tex create mode 100644 upgrade.fsx create mode 100644 upgrade.html create mode 100644 upgrade.ipynb create mode 100644 upgrade.md create mode 100644 upgrade.tex create mode 100644 users.fsx create mode 100644 users.html create mode 100644 users.ipynb create mode 100644 users.md create mode 100644 users.tex create mode 100644 zero-to-hero.fsx create mode 100644 zero-to-hero.html create mode 100644 zero-to-hero.ipynb create mode 100644 zero-to-hero.md create mode 100644 zero-to-hero.tex diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..989c9abb2 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,29 @@ +FROM mcr.microsoft.com/dotnet/sdk:7.0 + +RUN apt-get update \ + && apt-get -y upgrade \ + && apt-get -y install python3 python3-pip python3-dev ipython3 + +RUN python3 -m pip install --no-cache-dir notebook jupyterlab + +ARG NB_USER=fsdocs-user +ARG NB_UID=1000 +ENV USER ${NB_USER} +ENV NB_UID ${NB_UID} +ENV HOME /home/${NB_USER} + +RUN adduser --disabled-password \ + --gecos "Default user" \ + --uid ${NB_UID} \ + ${NB_USER} + +COPY . ${HOME} +USER root +RUN chown -R ${NB_UID} ${HOME} +USER ${NB_USER} + +ENV PATH="${PATH}:$HOME/.dotnet/tools/" + +RUN dotnet tool install --global Microsoft.dotnet-interactive --version 1.0.410202 + +RUN dotnet-interactive jupyter install diff --git a/NuGet.config b/NuGet.config new file mode 100644 index 000000000..cf1ace51a --- /dev/null +++ b/NuGet.config @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/README.txt b/README.txt new file mode 100644 index 000000000..b9b8ee8b6 --- /dev/null +++ b/README.txt @@ -0,0 +1,16 @@ + + +# Running notebooks in MyBinder + +The `Dockerfile` and `NuGet.config` allow us to run generated notebooks in [MyBinder](https://mybinder.org) + + +# How it works + +Notebooks are generated for all .md and .fsx files under docs as part of the build. + +* Dockerfile - see https://github.com/dotnet/interactive/blob/main/docs/CreateBinder.md + +* NuGet.config - likewise + +See MyBinder for creating URLs diff --git a/apidocs.fsx b/apidocs.fsx new file mode 100644 index 000000000..99155f6d6 --- /dev/null +++ b/apidocs.fsx @@ -0,0 +1,416 @@ +(** + +*) +#r "nuget: FSharp.Formatting,1.0.0" +(** +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=apidocs.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.ipynb) + +# API Documentation Generation + +The [command-line tool `fsdocs`](commandline.html) can be used to generate documentation +for F# libraries with XML comments. The documentation is normally built using `fsdocs build` and developed using `fsdocs watch`. For +the former the output will be placed in `output\reference` by default. + +## Selected projects + +`fsdocs` automatically selects the projects and "cracks" the project files for information + +* Projects with `GenerateDocumentationFile` and without `IsTestProject` are selected. + +* If Projects use `TargetFrameworks` (not `TargetFramework`, singular) only the firts target framework will be used to build the docs. + +```text + + true + +``` + +## Templates + +The HTML is built by instantiating a template. The template used is the first of: + +* `docs/reference/_template.html` + + +* `docs/_template.html` + + +* The default template + + +Usually, the same template can be used as for [other content](content.html). + +## Classic XML Doc Comments + +XML Doc Comments may use [the normal F# and C# XML doc standards](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/). + +The tags that form the core of the XML doc specification are: + +``` + * + * * + +* * * +* + +``` + +In addition, you may also use the [Recommended XML doc extensions for F# documentation tooling](https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md). + +* `` links + + +* Arbitrary paragraph-level HTML such as `` for bold in XML doc text + + +* `` giving documentation for the enclosing namespace + + +* `` to exclude from XML docs + + +* `` to give a category for an entity or member. An optional `index` attribute can be specified +to help sort the list of categories. + + +* `\(...\)` for inline math and `$$...$$` and `\[...\]`for math environments, see [http://docs.mathjax.org. +Some](http://docs.mathjax.org. +Some) escaping of characters (e.g. `<`, `>`) may be needed to form valid XML + + +An example of an XML documentation comment, assuming the code is in the namespace `TheNamespace`: + +*) +/// +/// A module +/// +/// +/// +/// A namespace to remember +/// +/// More on that +/// +/// +module SomeModule = + /// + /// Some actual comment + /// Another paragraph, see . + /// + /// + /// The input + /// + /// The output + /// + /// + /// Try using + /// + /// open TheNamespace + /// SomeModule.a + /// + /// + /// + /// Foo + let someFunction x = 42 + x + +/// +/// A type, see and +/// . +/// +/// +type SomeType() = + member x.P = 1 +(** +Like types, members are referred to by xml doc sig. These must currently be precise as the F# +compiler doesn't elaborate these references from simpler names: + +*) +type Class2() = + member this.Property = "more" + member this.Method0() = "more" + member this.Method1(c: string) = "more" + member this.Method2(c: string, o: obj) = "more" + +/// +/// and +/// and +/// and +let referringFunction1 () = "result" +(** +Generic types are referred to by .NET compiled name, e.g. + +*) +type GenericClass2<'T>() = + member this.Property = "more" + + member this.NonGenericMethod(_c: 'T) = "more" + + member this.GenericMethod(_c: 'T, _o: 'U) = "more" + +/// See +/// and +/// and +/// and +let referringFunction2 () = "result" +(** +### Cross-referencing with <seealso> + +Use `` within `` to create cross-references. + +For example: + +*) +module Forest = + + /// + /// Find at most limit foxes in current forest + /// + /// See also: + /// + let findFoxes (limit : int) = [] + + /// + /// Find at most limit squirrels in current forest + /// + /// See also: + /// + let findSquirrels (limit : int) = [] +(** +You can find the correct value for `cref` in the generated `.xml` documentation file (this will be generated alongside the assembly's `.dll``). + +You can also omit the `cref`'s arguments, and `fsdocs` will make an attempt to find the first member that matches. + +For example: + +``` + /// See also: +``` + +If the member cannot be found, a link to the containing module/type will be used instead. + +### Classic XMl Doc Comments: Excluding APIs from the docs + +If you want to exclude modules or functions from the API docs, you can use the `` tag. +It needs to be set on a separate triple-slashed line, and can either appear on its own or as part +of an existing `` (for example, you may wish to hide existing documentation while it's in progress). +The `` tag can be the first or last line in these cases. + +Some examples: + +*) +/// +module BottleKids1 = + let a = 42 + +// Ordinary comment +/// +module BottleKids2 = + let a = 43 + +/// +/// BottleKids3 provides improvements over BottleKids2 +module BottleKids3 = + let a = 44 + +/// BottleKids4 implements several new features over BottleKids3 +/// +module BottleKids4 = + let a = 45 + +/// +/// +/// BottleKids5 is all you'll ever need in terms of bottles or kids. +/// +module BottleKids5 = + let a = 46 +(** +Note that the comments for `BottleKids3` (and `BottleKids4`) will generate a warning. This is because +the `` tag will be parsed as part of the `summary` text, and so the documentation generator +can't be completely sure you meant to exclude the item, or whether it was a valid part of the documentation. +It will assume the exclusion was intended, but you may want to use explicit `` tags to remove +the warning. + +The warning will be of the following format: + +``` +Warning: detected "" in text of "" for "M:YourLib.BottleKids4". Please see https://fsprojects.github.io/FSharp.Formatting/apidocs.html#Classic-XML-Doc-Comments +``` +You will find that `[omit]` also works, but is considered part of the Markdown syntax and is +deprecated for XML Doc comments. This will also produce a warning, such as this: + +``` +The use of `[omit]` and other commands in XML comments is deprecated, please use XML extensions, see https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md +``` + + +## Go to Source links + +'fsdocs' normally automatically adds GitHub links to each functions, values and class members for further reference. + +This is normally done automatically based on the following settings: + +```xml + https://github.com/... + ... + git +``` + +If your source is not built from the same project where you are building documentation then +you may need these settings: + +```xml + ... -- the URL for the root of the source + ... -- the root soure folder at time of build +``` + +It is assumed that `sourceRepo` and `sourceFolder` have synchronized contents. + +## Markdown Comments + +You can use Markdown instead of XML in `///` comments. If you do, you should set `true` in +your F# project file. + +> Note: Markdown Comments are not supported in all F# IDE tooling. +> + +### Adding cross-type links to modules and types in the same assembly + +You can automatically add cross-type links to the documentation pages of other modules and types in the same assembly. +You can do this in two different ways: + +* Add a [markdown inline link](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links) were the link +title is the name of the type you want to link. + + + /// This will generate a link to [Foo.Bar] documentation + + +* Add a [Markdown inline code](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code) (using +back-ticks) where the code is the name of the type you want to link. + + + /// This will also generate a link to `Foo.Bar` documentation + + +You can use either the full name (including namespace and module) or the simple name of a type. +If more than one type is found with the same name, the link will not be generated. +If a type with the given name is not found in the same assembly, the link will not be generated. + +*) +/// Contains two types [Bar] and [Foo.Baz] +module Foo = + + /// Bar is just an `int` and belongs to module [Foo] + type Bar = int + + /// Baz contains a `Foo.Bar` as its `id` + type Baz = { id: Bar } + + /// This function operates on `Baz` types. + let f (b: Baz) = b.id * 42 + +/// Referencing [Foo3] will not generate a link as there is no type with the name `Foo3` +module Foo3 = + + /// This is not the same type as `Foo.Bar` + type Bar = double + + /// Using the simple name for [Bar] will fail to create a link because the name is duplicated in + /// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works. + let f2 b = b * 50 +(** +### Markdown Comments: Excluding APIs from the docs + +If you want to exclude modules or functions from the API docs you can use the `[omit]` tag. +It needs to be set on a separate triple-slashed line, but it could be either the first or the last: + +Example as last line: + +*) +/// Some actual comment +/// [omit] +module Bar = + let a = 42 +(** +Example as the first line: + +*) +/// [omit] +/// Some actual comment +module Bar2 = + let a = 42 +(** +## Building library documentation programmatically + +You can build library documentation programmatically using the functionality +in the [ApiDocs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html) type. To do this, load the assembly and open the necessary namespaces: + +*) +#r "FSharp.Formatting.ApiDocs.dll" + +open FSharp.Formatting.ApiDocs +open System.IO +(** +For example the [ApiDocs.GenerateHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateHtml) method: + +*) +let file = Path.Combine(root, "bin/YourLibrary.dll") + +let input = ApiDocInput.FromFile(file) + +ApiDocs.GenerateHtml( + [ input ], + output = Path.Combine(root, "output"), + collectionName = "YourLibrary", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [] +) +(** +### Adding extra dependencies + +When building a library programmatically, you might require a reference to an additional assembly. +You can pass this using the `otherFlags` argument. + +*) +let projectAssembly = Path.Combine(root, "bin/X.dll") + +let projectInput = ApiDocInput.FromFile(projectAssembly) + +ApiDocs.GenerateHtml( + [ projectInput ], + output = Path.Combine(root, "output"), + collectionName = "Project X", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [], + otherFlags = [ "-r:/root/ProjectY/bin/Debug/net6.0/Y.dll" ] +) +(** +or use `libDirs` to include all assemblies from an entire folder. +Tip: A combination of `true` in the fsproj file and setting `libDirs` to the compilation output path leads to only one folder with all dependencies referenced. +This might be easier, especially for large projects with many dependencies. + +*) +ApiDocs.GenerateHtml( + [ projectInput ], + output = Path.Combine(root, "output"), + collectionName = "Project X", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [], + libDirs = [ "ProjectX/bin/Debug/netstandard2.0" ] +) +(** +## Rebasing Links + +The `root` parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project's `` property. + +In some instances, you may wish to override the value for `root` (perhaps for local testing). To do this, you can use the command-line argument `--parameters root `. + +For example: + + [lang=text] + dotnet fsdocs build --output public/docs --parameters root ../ + + +*) + diff --git a/apidocs.html b/apidocs.html new file mode 100644 index 000000000..23d75de6e --- /dev/null +++ b/apidocs.html @@ -0,0 +1,795 @@ + + + + + + + + + + + + + + + + + + Generating API Docs | FSharp.Formatting + + + + + + + + + + + + + +
+
+ + + Header menu logo + FSharp.Formatting + +
+
+ + + + + +
+
+ +
+
+ +

Binder  +Script  +Notebook

+

API Documentation Generation

+

The command-line tool fsdocs can be used to generate documentation +for F# libraries with XML comments. The documentation is normally built using fsdocs build and developed using fsdocs watch. For +the former the output will be placed in output\reference by default.

+

Selected projects

+

fsdocs automatically selects the projects and "cracks" the project files for information

+
    +
  • Projects with GenerateDocumentationFile and without IsTestProject are selected.
    • +
  • If Projects use TargetFrameworks (not TargetFramework, singular) only the firts target framework will be used to build the docs.
    • +
+
    <PropertyGroup>
+      <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    </PropertyGroup>
+
+

Templates

+

The HTML is built by instantiating a template. The template used is the first of:

+
    +

  • docs/reference/_template.html

    • +

  • docs/_template.html

    • +
  • The default template
    • +
+

Usually, the same template can be used as for other content.

+

Classic XML Doc Comments

+

XML Doc Comments may use the normal F# and C# XML doc standards.

+

The tags that form the core of the XML doc specification are:

+
<c>	<para>	<see>*	<value>
+<code>	<param>*	<seealso>*
+<example>	<paramref>	<summary>
+<exception>*	<permission>*	<typeparam>*
+<include>*	<remarks>	<typeparamref>
+<list>	<inheritdoc>	<returns>
+
+

In addition, you may also use the Recommended XML doc extensions for F# documentation tooling.

+
    +

  • <a href = "..."> links

    • +

  • Arbitrary paragraph-level HTML such as <b> for bold in XML doc text

    • +

  • <namespacedoc> giving documentation for the enclosing namespace

    • +

  • <exclude/> to exclude from XML docs

    • +
  • +

    <category> to give a category for an entity or member. An optional index attribute can be specified +to help sort the list of categories.

    +
    • +
  • +

    \(...\) for inline math and $$...$$ and \[...\]for math environments, see http://docs.mathjax.org. +Some escaping of characters (e.g. &lt;, &gt;) may be needed to form valid XML

    +
    • +
+

An example of an XML documentation comment, assuming the code is in the namespace TheNamespace:

+
/// <summary>
+///   A module
+/// </summary>
+///
+/// <namespacedoc>
+///   <summary>A namespace to remember</summary>
+///
+///   <remarks>More on that</remarks>
+/// </namespacedoc>
+///
+module SomeModule =
+    /// <summary>
+    ///   Some actual comment
+    ///   <para>Another paragraph, see  <see cref="T:TheNamespace.SomeType"/>. </para>
+    /// </summary>
+    ///
+    /// <param name="x">The input</param>
+    ///
+    /// <returns>The output</returns>
+    ///
+    /// <example>
+    ///   Try using
+    ///   <code>
+    ///      open TheNamespace
+    ///      SomeModule.a
+    ///   </code>
+    /// </example>
+    ///
+    /// <category>Foo</category>
+    let someFunction x = 42 + x
+
+/// <summary>
+///   A type, see  <see cref="T:TheNamespace.SomeModule"/> and
+///  <see cref="M:TheNamespace.SomeModule.someFunction"/>.
+/// </summary>
+///
+type SomeType() =
+    member x.P = 1
+
+

Like types, members are referred to by xml doc sig. These must currently be precise as the F# +compiler doesn't elaborate these references from simpler names:

+
type Class2() =
+    member this.Property = "more"
+    member this.Method0() = "more"
+    member this.Method1(c: string) = "more"
+    member this.Method2(c: string, o: obj) = "more"
+
+/// <see cref="P:TheNamespace.Class2.Property" />
+/// and <see cref="M:TheNamespace.Class2.OtherMethod0" />
+/// and <see cref="M:TheNamespace.Class2.Method1(System.String)" />
+/// and <see cref="M:TheNamespace.Class2.Method2(System.String,System.Object)" />
+let referringFunction1 () = "result"
+
+

Generic types are referred to by .NET compiled name, e.g.

+
type GenericClass2<'T>() =
+    member this.Property = "more"
+
+    member this.NonGenericMethod(_c: 'T) = "more"
+
+    member this.GenericMethod(_c: 'T, _o: 'U) = "more"
+
+/// See <see cref="T:TheNamespace.GenericClass2`1" />
+/// and <see cref="P:TheNamespace.GenericClass2`1.Property" />
+/// and <see cref="M:TheNamespace.GenericClass2`1.NonGenericMethod(`0)" />
+/// and <see cref="M:TheNamespace.GenericClass2`1.GenericMethod``1(`0,``0)" />
+let referringFunction2 () = "result"
+
+

Cross-referencing with <seealso>

+

Use <seealso cref="..."/> within <summary> to create cross-references.

+

For example:

+
module Forest =
+
+    /// <summary>
+    /// Find at most <c>limit</c> foxes in current forest
+    ///
+    /// See also: <seealso cref="M:App.Forest.findSquirrels(System.Int32)"/>
+    /// </summary>
+    let findFoxes (limit : int) = []
+
+    /// <summary>
+    /// Find at most <c>limit</c> squirrels in current forest
+    ///
+    /// See also: <seealso cref="M:App.Forest.findFoxes(System.Int32)"/>
+    /// </summary>
+    let findSquirrels (limit : int) = []
+
+

You can find the correct value for cref in the generated .xml documentation file (this will be generated alongside the assembly's .dll`).

+

You can also omit the cref's arguments, and fsdocs will make an attempt to find the first member that matches.

+

For example:

+
    /// See also: <seealso cref="M:App.Forest.findSquirrels"/>
+
+

If the member cannot be found, a link to the containing module/type will be used instead.

+

Classic XMl Doc Comments: Excluding APIs from the docs

+

If you want to exclude modules or functions from the API docs, you can use the <exclude/> tag. +It needs to be set on a separate triple-slashed line, and can either appear on its own or as part +of an existing <summary> (for example, you may wish to hide existing documentation while it's in progress). +The <exclude/> tag can be the first or last line in these cases.

+

Some examples:

+
/// <exclude/>
+module BottleKids1 =
+    let a = 42
+
+// Ordinary comment
+/// <exclude/>
+module BottleKids2 =
+    let a = 43
+
+/// <exclude/>
+/// BottleKids3 provides improvements over BottleKids2
+module BottleKids3 =
+    let a = 44
+
+/// BottleKids4 implements several new features over BottleKids3
+/// <exclude/>
+module BottleKids4 =
+    let a = 45
+
+/// <exclude/>
+/// <summary>
+/// BottleKids5 is all you'll ever need in terms of bottles or kids.
+/// </summary>
+module BottleKids5 =
+    let a = 46
+
+

Note that the comments for BottleKids3 (and BottleKids4) will generate a warning. This is because +the <exclude/> tag will be parsed as part of the summary text, and so the documentation generator +can't be completely sure you meant to exclude the item, or whether it was a valid part of the documentation. +It will assume the exclusion was intended, but you may want to use explicit <summary> tags to remove +the warning.

+

The warning will be of the following format:

+
Warning: detected "<exclude/>" in text of "<summary>" for "M:YourLib.BottleKids4". Please see https://fsprojects.github.io/FSharp.Formatting/apidocs.html#Classic-XML-Doc-Comments
+
+

You will find that [omit] also works, but is considered part of the Markdown syntax and is +deprecated for XML Doc comments. This will also produce a warning, such as this:

+
The use of `[omit]` and other commands in XML comments is deprecated, please use XML extensions, see https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md
+
+

Go to Source links

+

'fsdocs' normally automatically adds GitHub links to each functions, values and class members for further reference.

+

This is normally done automatically based on the following settings:

+
    <RepositoryUrl>https://github.com/...</RepositoryUrl>
+    <RepositoryBranch>...</RepositoryBranch>
+    <RepositoryType>git</RepositoryType>
+
+

If your source is not built from the same project where you are building documentation then +you may need these settings:

+
    <FsDocsSourceRepository>...</FsDocsSourceRepository> -- the URL for the root of the source
+    <FsDocsSourceFolder>...</FsDocsSourceFolder>         -- the root soure folder at time of build
+
+

It is assumed that sourceRepo and sourceFolder have synchronized contents.

+

Markdown Comments

+

You can use Markdown instead of XML in /// comments. If you do, you should set <UsesMarkdownComments>true</UsesMarkdownComments> in +your F# project file.

+
+

Note: Markdown Comments are not supported in all F# IDE tooling.

+
+

Adding cross-type links to modules and types in the same assembly

+

You can automatically add cross-type links to the documentation pages of other modules and types in the same assembly. +You can do this in two different ways:

+
    +
  • +

    Add a markdown inline link were the link +title is the name of the type you want to link.

    +
    /// This will generate a link to [Foo.Bar] documentation
+
    +
    • +
  • +

    Add a Markdown inline code (using +back-ticks) where the code is the name of the type you want to link.

    +
    /// This will also generate a link to `Foo.Bar` documentation
+
    +
    • +
+

You can use either the full name (including namespace and module) or the simple name of a type. +If more than one type is found with the same name, the link will not be generated. +If a type with the given name is not found in the same assembly, the link will not be generated.

+
/// Contains two types [Bar] and [Foo.Baz]
+module Foo =
+
+    /// Bar is just an `int` and belongs to module [Foo]
+    type Bar = int
+
+    /// Baz contains a `Foo.Bar` as its `id`
+    type Baz = { id: Bar }
+
+    /// This function operates on `Baz` types.
+    let f (b: Baz) = b.id * 42
+
+/// Referencing [Foo3] will not generate a link as there is no type with the name `Foo3`
+module Foo3 =
+
+    /// This is not the same type as `Foo.Bar`
+    type Bar = double
+
+    /// Using the simple name for [Bar] will fail to create a link because the name is duplicated in
+    /// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works.
+    let f2 b = b * 50
+
+

Markdown Comments: Excluding APIs from the docs

+

If you want to exclude modules or functions from the API docs you can use the [omit] tag. +It needs to be set on a separate triple-slashed line, but it could be either the first or the last:

+

Example as last line:

+
/// Some actual comment
+/// [omit]
+module Bar =
+    let a = 42
+
+

Example as the first line:

+
/// [omit]
+/// Some actual comment
+module Bar2 =
+    let a = 42
+
+

Building library documentation programmatically

+

You can build library documentation programmatically using the functionality +in the ApiDocs type. To do this, load the assembly and open the necessary namespaces:

+
#r "FSharp.Formatting.ApiDocs.dll"
+
+open FSharp.Formatting.ApiDocs
+open System.IO
+
+

For example the ApiDocs.GenerateHtml method:

+
let file = Path.Combine(root, "bin/YourLibrary.dll")
+
+let input = ApiDocInput.FromFile(file)
+
+ApiDocs.GenerateHtml(
+    [ input ],
+    output = Path.Combine(root, "output"),
+    collectionName = "YourLibrary",
+    template = Path.Combine(root, "templates", "template.html"),
+    substitutions = []
+)
+
+

Adding extra dependencies

+

When building a library programmatically, you might require a reference to an additional assembly. +You can pass this using the otherFlags argument.

+
let projectAssembly = Path.Combine(root, "bin/X.dll")
+
+let projectInput = ApiDocInput.FromFile(projectAssembly)
+
+ApiDocs.GenerateHtml(
+    [ projectInput ],
+    output = Path.Combine(root, "output"),
+    collectionName = "Project X",
+    template = Path.Combine(root, "templates", "template.html"),
+    substitutions = [],
+    otherFlags = [ "-r:/root/ProjectY/bin/Debug/net6.0/Y.dll" ]
+)
+
+

or use libDirs to include all assemblies from an entire folder. +Tip: A combination of <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> in the fsproj file and setting libDirs to the compilation output path leads to only one folder with all dependencies referenced. +This might be easier, especially for large projects with many dependencies.

+
ApiDocs.GenerateHtml(
+    [ projectInput ],
+    output = Path.Combine(root, "output"),
+    collectionName = "Project X",
+    template = Path.Combine(root, "templates", "template.html"),
+    substitutions = [],
+    libDirs = [ "ProjectX/bin/Debug/netstandard2.0" ]
+)
+
+

Rebasing Links

+

The root parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project's <PackageProjectUrl> property.

+

In some instances, you may wish to override the value for root (perhaps for local testing). To do this, you can use the command-line argument --parameters root <base>.

+

For example:

+
dotnet fsdocs build --output public/docs --parameters root ../
+
+ +
val root: string
+
type 'T list = List<'T>
+
val someFunction: x: int -> int
 <summary>
   Some actual comment
   <para>Another paragraph, see <see cref="T:TheNamespace.SomeType"/>. </para>
 </summary>

 <param name="x">The input</param>

 <returns>The output</returns>

 <example>
   Try using
   <code>
      open TheNamespace
      SomeModule.a
   </code>
 </example>

 <category>Foo</category>
+
val x: int
+
Multiple items
type SomeType = + new: unit -> SomeType + member P: int
 <summary>
   A type, see <see cref="T:TheNamespace.SomeModule"/> and
  <see cref="M:TheNamespace.SomeModule.someFunction"/>.
 </summary>


--------------------
new: unit -> SomeType
+
val x: SomeType
+
member SomeType.P: int
+
Multiple items
type Class2 = + new: unit -> Class2 + member Method0: unit -> string + member Method1: c: string -> string + member Method2: c: string * o: obj -> string + member Property: string

--------------------
new: unit -> Class2
+
val this: Class2
+
val c: string
+
Multiple items
val string: value: 'T -> string

--------------------
type string = System.String
+
val o: obj
+
type obj = System.Object
+
val referringFunction1: unit -> string
 <see cref="P:TheNamespace.Class2.Property" />
 and <see cref="M:TheNamespace.Class2.OtherMethod0" />
 and <see cref="M:TheNamespace.Class2.Method1(System.String)" />
 and <see cref="M:TheNamespace.Class2.Method2(System.String,System.Object)" />
+
Multiple items
type GenericClass2<'T> = + new: unit -> GenericClass2<'T> + member GenericMethod: _c: 'T * _o: 'U -> string + member NonGenericMethod: _c: 'T -> string + member Property: string

--------------------
new: unit -> GenericClass2<'T>
+
'T
+
val this: GenericClass2<'T>
+
val _c: 'T
+
val _o: 'U
+
'U
+
val referringFunction2: unit -> string
 See <see cref="T:TheNamespace.GenericClass2`1" />
 and <see cref="P:TheNamespace.GenericClass2`1.Property" />
 and <see cref="M:TheNamespace.GenericClass2`1.NonGenericMethod(`0)" />
 and <see cref="M:TheNamespace.GenericClass2`1.GenericMethod``1(`0,``0)" />
+
val findFoxes: limit: int -> 'a list
 <summary>
 Find at most <c>limit</c> foxes in current forest

 See also: <seealso cref="M:App.Forest.findSquirrels(System.Int32)"/>
 </summary>
+
val limit: int
+
Multiple items
val int: value: 'T -> int (requires member op_Explicit)

--------------------
type int = int32

--------------------
type int<'Measure> = + int
+
val findSquirrels: limit: int -> 'a list
 <summary>
 Find at most <c>limit</c> squirrels in current forest

 See also: <seealso cref="M:App.Forest.findFoxes(System.Int32)"/>
 </summary>
+
val a: int
+
type Bar = int
 Bar is just an `int` and belongs to module [Foo]
+
type Baz = + { id: Bar }
 Baz contains a `Foo.Bar` as its `id`
+
val id: x: 'T -> 'T
+
val f: b: Baz -> Bar
 This function operates on `Baz` types.
+
val b: Baz
+
Baz.id: Bar
+
type Bar = double
 This is not the same type as `Foo.Bar`
+
Multiple items
val double: value: 'T -> double (requires member op_Explicit)

--------------------
type double = System.Double

--------------------
type double<'Measure> = float<'Measure>
+
val f2: b: int -> int
 Using the simple name for [Bar] will fail to create a link because the name is duplicated in
 [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works.
+
val b: int
+
Multiple items
namespace FSharp

--------------------
namespace Microsoft.FSharp
+
namespace FSharp.Formatting
+
namespace FSharp.Formatting.ApiDocs
+
namespace System
+
namespace System.IO
+
val file: string
+
type Path = + static member ChangeExtension: path: string * extension: string -> string + static member Combine: path1: string * path2: string -> string + 3 overloads + static member EndsInDirectorySeparator: path: ReadOnlySpan<char> -> bool + 1 overload + static member Exists: path: string -> bool + static member GetDirectoryName: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload + static member GetExtension: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload + static member GetFileName: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload + static member GetFileNameWithoutExtension: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload + static member GetFullPath: path: string -> string + 1 overload + static member GetInvalidFileNameChars: unit -> char array + ...
<summary>Performs operations on <see cref="T:System.String" /> instances that contain file or directory path information. These operations are performed in a cross-platform manner.</summary>
+
Path.Combine([<System.ParamArray>] paths: string array) : string
Path.Combine(path1: string, path2: string) : string
Path.Combine(path1: string, path2: string, path3: string) : string
Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
+
val input: ApiDocInput
+
type ApiDocInput = + { + Path: string + XmlFile: string option + SourceFolder: string option + SourceRepo: string option + Substitutions: Substitutions option + MarkdownComments: bool + Warn: bool + PublicOnly: bool + } + static member FromFile: assemblyPath: string * ?mdcomments: bool * ?substitutions: Substitutions * ?sourceRepo: string * ?sourceFolder: string * ?publicOnly: bool * ?warn: bool -> ApiDocInput
<summary> + Represents an input assembly for API doc generation +</summary>
+
static member ApiDocInput.FromFile: assemblyPath: string * ?mdcomments: bool * ?substitutions: FSharp.Formatting.Templating.Substitutions * ?sourceRepo: string * ?sourceFolder: string * ?publicOnly: bool * ?warn: bool -> ApiDocInput
+
type ApiDocs = + static member GenerateHtml: inputs: ApiDocInput list * output: string * collectionName: string * substitutions: Substitutions * ?template: string * ?root: string * ?qualify: bool * ?libDirs: string list * ?otherFlags: string list * ?urlRangeHighlight: (Uri -> int -> int -> string) * ?onError: (string -> unit) -> ApiDocModel * ApiDocsSearchIndexEntry array + static member GenerateMarkdown: inputs: ApiDocInput list * output: string * collectionName: string * substitutions: Substitutions * ?template: string * ?root: string * ?qualify: bool * ?libDirs: string list * ?otherFlags: string list * ?urlRangeHighlight: (Uri -> int -> int -> string) * ?onError: (string -> unit) -> ApiDocModel * ApiDocsSearchIndexEntry array + static member GenerateModel: inputs: ApiDocInput list * collectionName: string * substitutions: Substitutions * ?qualify: bool * ?libDirs: string list * ?otherFlags: string list * ?root: string * ?urlRangeHighlight: (Uri -> int -> int -> string) * ?onError: (string -> unit) * ?extension: ApiDocFileExtensions -> ApiDocModel + static member SearchIndexEntriesForModel: model: ApiDocModel -> ApiDocsSearchIndexEntry array
<summary> + This type exposes the functionality for producing documentation model from `dll` files with associated `xml` files + generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the `Generate` method. + </summary>
<namespacedoc><summary>Functionality relating to generating API documentation</summary></namespacedoc>
+
static member ApiDocs.GenerateHtml: inputs: ApiDocInput list * output: string * collectionName: string * substitutions: FSharp.Formatting.Templating.Substitutions * ?template: string * ?root: string * ?qualify: bool * ?libDirs: string list * ?otherFlags: string list * ?urlRangeHighlight: (System.Uri -> int -> int -> string) * ?onError: (string -> unit) -> ApiDocModel * ApiDocsSearchIndexEntry array
+
val projectAssembly: string
+
val projectInput: ApiDocInput
+ +
+
+ + + +
+
    +

    Type something to start searching.

    +
    +     + + + + + + + + \ No newline at end of file diff --git a/apidocs.ipynb b/apidocs.ipynb new file mode 100644 index 000000000..ae0e66cac --- /dev/null +++ b/apidocs.ipynb @@ -0,0 +1,726 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "#r \"nuget: FSharp.Formatting,1.0.0\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=apidocs.ipynb)\u0026emsp;\n", + "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.fsx)\u0026emsp;\n", + "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.ipynb)\n", + "\n", + "# API Documentation Generation\n", + "\n", + "The [command-line tool `fsdocs`](commandline.html) can be used to generate documentation\n", + "for F# libraries with XML comments. The documentation is normally built using `fsdocs build` and developed using `fsdocs watch`. For\n", + "the former the output will be placed in `output\\reference` by default.\n", + "\n", + "## Selected projects\n", + "\n", + "`fsdocs` automatically selects the projects and \"cracks\" the project files for information\n", + "\n", + "* Projects with `GenerateDocumentationFile` and without `IsTestProject` are selected.\n", + "\n", + "* If Projects use `TargetFrameworks` (not `TargetFramework`, singular) only the firts target framework will be used to build the docs.\n", + "\n", + "```text\n", + " \u003cPropertyGroup\u003e\n", + " \u003cGenerateDocumentationFile\u003etrue\u003c/GenerateDocumentationFile\u003e\n", + " \u003c/PropertyGroup\u003e\n", + "```\n", + "\n", + "## Templates\n", + "\n", + "The HTML is built by instantiating a template. The template used is the first of:\n", + "\n", + "* `docs/reference/_template.html`\n", + " \n", + "\n", + "* `docs/_template.html`\n", + " \n", + "\n", + "* The default template\n", + " \n", + "\n", + "Usually, the same template can be used as for [other content](content.html).\n", + "\n", + "## Classic XML Doc Comments\n", + "\n", + "XML Doc Comments may use [the normal F# and C# XML doc standards](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/).\n", + "\n", + "The tags that form the core of the XML doc specification are:\n", + "\n", + "```\n", + "\u003cc\u003e\t\u003cpara\u003e\t\u003csee\u003e*\t\u003cvalue\u003e\n", + "\u003ccode\u003e\t\u003cparam\u003e*\t\u003cseealso\u003e*\n", + "\u003cexample\u003e\t\u003cparamref\u003e\t\u003csummary\u003e\n", + "\u003cexception\u003e*\t\u003cpermission\u003e*\t\u003ctypeparam\u003e*\n", + "\u003cinclude\u003e*\t\u003cremarks\u003e\t\u003ctypeparamref\u003e\n", + "\u003clist\u003e\t\u003cinheritdoc\u003e\t\u003creturns\u003e\n", + "```\n", + "\n", + "In addition, you may also use the [Recommended XML doc extensions for F# documentation tooling](https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md).\n", + "\n", + "* `\u003ca href = \"...\"\u003e` links\n", + " \n", + "\n", + "* Arbitrary paragraph-level HTML such as `\u003cb\u003e` for bold in XML doc text\n", + " \n", + "\n", + "* `\u003cnamespacedoc\u003e` giving documentation for the enclosing namespace\n", + " \n", + "\n", + "* `\u003cexclude/\u003e` to exclude from XML docs\n", + " \n", + "\n", + "* `\u003ccategory\u003e` to give a category for an entity or member. An optional `index` attribute can be specified\n", + "to help sort the list of categories.\n", + " \n", + "\n", + "* `\\(...\\)` for inline math and `$$...$$` and `\\[...\\]`for math environments, see [http://docs.mathjax.org.\n", + "Some](http://docs.mathjax.org.\n", + "Some) escaping of characters (e.g. `\u0026lt;`, `\u0026gt;`) may be needed to form valid XML\n", + " \n", + "\n", + "An example of an XML documentation comment, assuming the code is in the namespace `TheNamespace`:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "/// \u003csummary\u003e\n", + "/// A module\n", + "/// \u003c/summary\u003e\n", + "///\n", + "/// \u003cnamespacedoc\u003e\n", + "/// \u003csummary\u003eA namespace to remember\u003c/summary\u003e\n", + "///\n", + "/// \u003cremarks\u003eMore on that\u003c/remarks\u003e\n", + "/// \u003c/namespacedoc\u003e\n", + "///\n", + "module SomeModule =\n", + " /// \u003csummary\u003e\n", + " /// Some actual comment\n", + " /// \u003cpara\u003eAnother paragraph, see \u003csee cref=\"T:TheNamespace.SomeType\"/\u003e. \u003c/para\u003e\n", + " /// \u003c/summary\u003e\n", + " ///\n", + " /// \u003cparam name=\"x\"\u003eThe input\u003c/param\u003e\n", + " ///\n", + " /// \u003creturns\u003eThe output\u003c/returns\u003e\n", + " ///\n", + " /// \u003cexample\u003e\n", + " /// Try using\n", + " /// \u003ccode\u003e\n", + " /// open TheNamespace\n", + " /// SomeModule.a\n", + " /// \u003c/code\u003e\n", + " /// \u003c/example\u003e\n", + " ///\n", + " /// \u003ccategory\u003eFoo\u003c/category\u003e\n", + " let someFunction x = 42 + x\n", + "\n", + "/// \u003csummary\u003e\n", + "/// A type, see \u003csee cref=\"T:TheNamespace.SomeModule\"/\u003e and\n", + "/// \u003csee cref=\"M:TheNamespace.SomeModule.someFunction\"/\u003e.\n", + "/// \u003c/summary\u003e\n", + "///\n", + "type SomeType() =\n", + " member x.P = 1\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "Like types, members are referred to by xml doc sig. These must currently be precise as the F#\n", + "compiler doesn\u0027t elaborate these references from simpler names:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "type Class2() =\n", + " member this.Property = \"more\"\n", + " member this.Method0() = \"more\"\n", + " member this.Method1(c: string) = \"more\"\n", + " member this.Method2(c: string, o: obj) = \"more\"\n", + "\n", + "/// \u003csee cref=\"P:TheNamespace.Class2.Property\" /\u003e\n", + "/// and \u003csee cref=\"M:TheNamespace.Class2.OtherMethod0\" /\u003e\n", + "/// and \u003csee cref=\"M:TheNamespace.Class2.Method1(System.String)\" /\u003e\n", + "/// and \u003csee cref=\"M:TheNamespace.Class2.Method2(System.String,System.Object)\" /\u003e\n", + "let referringFunction1 () = \"result\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "Generic types are referred to by .NET compiled name, e.g.\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "type GenericClass2\u003c\u0027T\u003e() =\n", + " member this.Property = \"more\"\n", + "\n", + " member this.NonGenericMethod(_c: \u0027T) = \"more\"\n", + "\n", + " member this.GenericMethod(_c: \u0027T, _o: \u0027U) = \"more\"\n", + "\n", + "/// See \u003csee cref=\"T:TheNamespace.GenericClass2`1\" /\u003e\n", + "/// and \u003csee cref=\"P:TheNamespace.GenericClass2`1.Property\" /\u003e\n", + "/// and \u003csee cref=\"M:TheNamespace.GenericClass2`1.NonGenericMethod(`0)\" /\u003e\n", + "/// and \u003csee cref=\"M:TheNamespace.GenericClass2`1.GenericMethod``1(`0,``0)\" /\u003e\n", + "let referringFunction2 () = \"result\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "### Cross-referencing with \u0026lt;seealso\u0026gt;\n", + "\n", + "Use `\u003cseealso cref=\"...\"/\u003e` within `\u003csummary\u003e` to create cross-references.\n", + "\n", + "For example:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "module Forest =\n", + "\n", + " /// \u003csummary\u003e\n", + " /// Find at most \u003cc\u003elimit\u003c/c\u003e foxes in current forest\n", + " ///\n", + " /// See also: \u003cseealso cref=\"M:App.Forest.findSquirrels(System.Int32)\"/\u003e\n", + " /// \u003c/summary\u003e\n", + " let findFoxes (limit : int) = []\n", + "\n", + " /// \u003csummary\u003e\n", + " /// Find at most \u003cc\u003elimit\u003c/c\u003e squirrels in current forest\n", + " ///\n", + " /// See also: \u003cseealso cref=\"M:App.Forest.findFoxes(System.Int32)\"/\u003e\n", + " /// \u003c/summary\u003e\n", + " let findSquirrels (limit : int) = []\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "You can find the correct value for `cref` in the generated `.xml` documentation file (this will be generated alongside the assembly\u0027s `.dll``).\n", + "\n", + "You can also omit the `cref`\u0027s arguments, and `fsdocs` will make an attempt to find the first member that matches.\n", + "\n", + "For example:\n", + "\n", + "```\n", + " /// See also: \u003cseealso cref=\"M:App.Forest.findSquirrels\"/\u003e\n", + "```\n", + "\n", + "If the member cannot be found, a link to the containing module/type will be used instead.\n", + "\n", + "### Classic XMl Doc Comments: Excluding APIs from the docs\n", + "\n", + "If you want to exclude modules or functions from the API docs, you can use the `\u003cexclude/\u003e` tag.\n", + "It needs to be set on a separate triple-slashed line, and can either appear on its own or as part\n", + "of an existing `\u003csummary\u003e` (for example, you may wish to hide existing documentation while it\u0027s in progress).\n", + "The `\u003cexclude/\u003e` tag can be the first or last line in these cases.\n", + "\n", + "Some examples:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "/// \u003cexclude/\u003e\n", + "module BottleKids1 =\n", + " let a = 42\n", + "\n", + "// Ordinary comment\n", + "/// \u003cexclude/\u003e\n", + "module BottleKids2 =\n", + " let a = 43\n", + "\n", + "/// \u003cexclude/\u003e\n", + "/// BottleKids3 provides improvements over BottleKids2\n", + "module BottleKids3 =\n", + " let a = 44\n", + "\n", + "/// BottleKids4 implements several new features over BottleKids3\n", + "/// \u003cexclude/\u003e\n", + "module BottleKids4 =\n", + " let a = 45\n", + "\n", + "/// \u003cexclude/\u003e\n", + "/// \u003csummary\u003e\n", + "/// BottleKids5 is all you\u0027ll ever need in terms of bottles or kids.\n", + "/// \u003c/summary\u003e\n", + "module BottleKids5 =\n", + " let a = 46\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "Note that the comments for `BottleKids3` (and `BottleKids4`) will generate a warning. This is because\n", + "the `\u003cexclude/\u003e` tag will be parsed as part of the `summary` text, and so the documentation generator\n", + "can\u0027t be completely sure you meant to exclude the item, or whether it was a valid part of the documentation.\n", + "It will assume the exclusion was intended, but you may want to use explicit `\u003csummary\u003e` tags to remove\n", + "the warning.\n", + "\n", + "The warning will be of the following format:\n", + "\n", + "```\n", + "Warning: detected \"\u003cexclude/\u003e\" in text of \"\u003csummary\u003e\" for \"M:YourLib.BottleKids4\". Please see https://fsprojects.github.io/FSharp.Formatting/apidocs.html#Classic-XML-Doc-Comments\n", + "```\n", + "You will find that `[omit]` also works, but is considered part of the Markdown syntax and is\n", + "deprecated for XML Doc comments. This will also produce a warning, such as this:\n", + "\n", + "```\n", + "The use of `[omit]` and other commands in XML comments is deprecated, please use XML extensions, see https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md\n", + "```\n", + "\n", + "\n", + "## Go to Source links\n", + "\n", + "\u0027fsdocs\u0027 normally automatically adds GitHub links to each functions, values and class members for further reference.\n", + "\n", + "This is normally done automatically based on the following settings:\n", + "\n", + "```xml\n", + " \u003cRepositoryUrl\u003ehttps://github.com/...\u003c/RepositoryUrl\u003e\n", + " \u003cRepositoryBranch\u003e...\u003c/RepositoryBranch\u003e\n", + " \u003cRepositoryType\u003egit\u003c/RepositoryType\u003e\n", + "```\n", + "\n", + "If your source is not built from the same project where you are building documentation then\n", + "you may need these settings:\n", + "\n", + "```xml\n", + " \u003cFsDocsSourceRepository\u003e...\u003c/FsDocsSourceRepository\u003e -- the URL for the root of the source\n", + " \u003cFsDocsSourceFolder\u003e...\u003c/FsDocsSourceFolder\u003e -- the root soure folder at time of build\n", + "```\n", + "\n", + "It is assumed that `sourceRepo` and `sourceFolder` have synchronized contents.\n", + "\n", + "## Markdown Comments\n", + "\n", + "You can use Markdown instead of XML in `///` comments. If you do, you should set `\u003cUsesMarkdownComments\u003etrue\u003c/UsesMarkdownComments\u003e` in\n", + "your F# project file.\n", + "\n", + "\u003e Note: Markdown Comments are not supported in all F# IDE tooling.\n", + "\u003e \n", + "\n", + "### Adding cross-type links to modules and types in the same assembly\n", + "\n", + "You can automatically add cross-type links to the documentation pages of other modules and types in the same assembly.\n", + "You can do this in two different ways:\n", + "\n", + "* Add a [markdown inline link](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links) were the link\n", + "title is the name of the type you want to link.\n", + " \n", + "\n", + " /// This will generate a link to [Foo.Bar] documentation\n", + " \n", + "\n", + "* Add a [Markdown inline code](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code) (using\n", + "back-ticks) where the code is the name of the type you want to link.\n", + " \n", + "\n", + " /// This will also generate a link to `Foo.Bar` documentation\n", + " \n", + "\n", + "You can use either the full name (including namespace and module) or the simple name of a type.\n", + "If more than one type is found with the same name, the link will not be generated.\n", + "If a type with the given name is not found in the same assembly, the link will not be generated.\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "/// Contains two types [Bar] and [Foo.Baz]\n", + "module Foo =\n", + "\n", + " /// Bar is just an `int` and belongs to module [Foo]\n", + " type Bar = int\n", + "\n", + " /// Baz contains a `Foo.Bar` as its `id`\n", + " type Baz = { id: Bar }\n", + "\n", + " /// This function operates on `Baz` types.\n", + " let f (b: Baz) = b.id * 42\n", + "\n", + "/// Referencing [Foo3] will not generate a link as there is no type with the name `Foo3`\n", + "module Foo3 =\n", + "\n", + " /// This is not the same type as `Foo.Bar`\n", + " type Bar = double\n", + "\n", + " /// Using the simple name for [Bar] will fail to create a link because the name is duplicated in\n", + " /// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works.\n", + " let f2 b = b * 50\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "### Markdown Comments: Excluding APIs from the docs\n", + "\n", + "If you want to exclude modules or functions from the API docs you can use the `[omit]` tag.\n", + "It needs to be set on a separate triple-slashed line, but it could be either the first or the last:\n", + "\n", + "Example as last line:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "/// Some actual comment\n", + "/// [omit]\n", + "module Bar =\n", + " let a = 42\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "Example as the first line:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "/// [omit]\n", + "/// Some actual comment\n", + "module Bar2 =\n", + " let a = 42\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "## Building library documentation programmatically\n", + "\n", + "You can build library documentation programmatically using the functionality\n", + "in the [ApiDocs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html) type. To do this, load the assembly and open the necessary namespaces:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "#r \"FSharp.Formatting.ApiDocs.dll\"\n", + "\n", + "open FSharp.Formatting.ApiDocs\n", + "open System.IO\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "For example the [ApiDocs.GenerateHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateHtml) method:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "let file = Path.Combine(root, \"bin/YourLibrary.dll\")\n", + "\n", + "let input = ApiDocInput.FromFile(file)\n", + "\n", + "ApiDocs.GenerateHtml(\n", + " [ input ],\n", + " output = Path.Combine(root, \"output\"),\n", + " collectionName = \"YourLibrary\",\n", + " template = Path.Combine(root, \"templates\", \"template.html\"),\n", + " substitutions = []\n", + ")\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "### Adding extra dependencies\n", + "\n", + "When building a library programmatically, you might require a reference to an additional assembly.\n", + "You can pass this using the `otherFlags` argument.\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "let projectAssembly = Path.Combine(root, \"bin/X.dll\")\n", + "\n", + "let projectInput = ApiDocInput.FromFile(projectAssembly)\n", + "\n", + "ApiDocs.GenerateHtml(\n", + " [ projectInput ],\n", + " output = Path.Combine(root, \"output\"),\n", + " collectionName = \"Project X\",\n", + " template = Path.Combine(root, \"templates\", \"template.html\"),\n", + " substitutions = [],\n", + " otherFlags = [ \"-r:/root/ProjectY/bin/Debug/net6.0/Y.dll\" ]\n", + ")\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "or use `libDirs` to include all assemblies from an entire folder.\n", + "Tip: A combination of `\u003cCopyLocalLockFileAssemblies\u003etrue\u003c/CopyLocalLockFileAssemblies\u003e` in the fsproj file and setting `libDirs` to the compilation output path leads to only one folder with all dependencies referenced.\n", + "This might be easier, especially for large projects with many dependencies.\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "ApiDocs.GenerateHtml(\n", + " [ projectInput ],\n", + " output = Path.Combine(root, \"output\"),\n", + " collectionName = \"Project X\",\n", + " template = Path.Combine(root, \"templates\", \"template.html\"),\n", + " substitutions = [],\n", + " libDirs = [ \"ProjectX/bin/Debug/netstandard2.0\" ]\n", + ")\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "## Rebasing Links\n", + "\n", + "The `root` parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project\u0027s `\u003cPackageProjectUrl\u003e` property.\n", + "\n", + "In some instances, you may wish to override the value for `root` (perhaps for local testing). To do this, you can use the command-line argument `--parameters root \u003cbase\u003e`.\n", + "\n", + "For example:\n", + "\n", + " [lang=text]\n", + " dotnet fsdocs build --output public/docs --parameters root ../\n", + "\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/apidocs.md b/apidocs.md new file mode 100644 index 000000000..8c3cceac0 --- /dev/null +++ b/apidocs.md @@ -0,0 +1,424 @@ +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=apidocs.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//apidocs.ipynb) + +# API Documentation Generation + +The [command-line tool `fsdocs`](commandline.html) can be used to generate documentation +for F# libraries with XML comments. The documentation is normally built using `fsdocs build` and developed using `fsdocs watch`. For +the former the output will be placed in `output\reference` by default. + +## Selected projects + +`fsdocs` automatically selects the projects and "cracks" the project files for information + +* Projects with `GenerateDocumentationFile` and without `IsTestProject` are selected. + +* If Projects use `TargetFrameworks` (not `TargetFramework`, singular) only the firts target framework will be used to build the docs. + + + true + + +## Templates + +The HTML is built by instantiating a template. The template used is the first of: + +* `docs/reference/_template.html` + + +* `docs/_template.html` + + +* The default template + + +Usually, the same template can be used as for [other content](content.html). + +## Classic XML Doc Comments + +XML Doc Comments may use [the normal F# and C# XML doc standards](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/). + +The tags that form the core of the XML doc specification are: + +```fsharp + * + * * + +* * * +* + + +``` + +In addition, you may also use the [Recommended XML doc extensions for F# documentation tooling](https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md). + +* `` links + + +* Arbitrary paragraph-level HTML such as `` for bold in XML doc text + + +* `` giving documentation for the enclosing namespace + + +* `` to exclude from XML docs + + +* `` to give a category for an entity or member. An optional `index` attribute can be specified +to help sort the list of categories. + + +* `\(...\)` for inline math and `$$...$$` and `\[...\]`for math environments, see [http://docs.mathjax.org. +Some](http://docs.mathjax.org. +Some) escaping of characters (e.g. `<`, `>`) may be needed to form valid XML + + +An example of an XML documentation comment, assuming the code is in the namespace `TheNamespace`: + +```fsharp +/// +/// A module +/// +/// +/// +/// A namespace to remember +/// +/// More on that +/// +/// +module SomeModule = + /// + /// Some actual comment + /// Another paragraph, see . + /// + /// + /// The input + /// + /// The output + /// + /// + /// Try using + /// + /// open TheNamespace + /// SomeModule.a + /// + /// + /// + /// Foo + let someFunction x = 42 + x + +/// +/// A type, see and +/// . +/// +/// +type SomeType() = + member x.P = 1 +``` + +Like types, members are referred to by xml doc sig. These must currently be precise as the F# +compiler doesn't elaborate these references from simpler names: + +```fsharp +type Class2() = + member this.Property = "more" + member this.Method0() = "more" + member this.Method1(c: string) = "more" + member this.Method2(c: string, o: obj) = "more" + +/// +/// and +/// and +/// and +let referringFunction1 () = "result" +``` + +Generic types are referred to by .NET compiled name, e.g. + +```fsharp +type GenericClass2<'T>() = + member this.Property = "more" + + member this.NonGenericMethod(_c: 'T) = "more" + + member this.GenericMethod(_c: 'T, _o: 'U) = "more" + +/// See +/// and +/// and +/// and +let referringFunction2 () = "result" +``` + +### Cross-referencing with <seealso> + +Use `` within `` to create cross-references. + +For example: + +```fsharp +module Forest = + + /// + /// Find at most limit foxes in current forest + /// + /// See also: + /// + let findFoxes (limit : int) = [] + + /// + /// Find at most limit squirrels in current forest + /// + /// See also: + /// + let findSquirrels (limit : int) = [] +``` + +You can find the correct value for `cref` in the generated `.xml` documentation file (this will be generated alongside the assembly's `.dll``). + +You can also omit the `cref`'s arguments, and `fsdocs` will make an attempt to find the first member that matches. + +For example: + +```fsharp + /// See also: + +``` + +If the member cannot be found, a link to the containing module/type will be used instead. + +### Classic XMl Doc Comments: Excluding APIs from the docs + +If you want to exclude modules or functions from the API docs, you can use the `` tag. +It needs to be set on a separate triple-slashed line, and can either appear on its own or as part +of an existing `` (for example, you may wish to hide existing documentation while it's in progress). +The `` tag can be the first or last line in these cases. + +Some examples: + +```fsharp +/// +module BottleKids1 = + let a = 42 + +// Ordinary comment +/// +module BottleKids2 = + let a = 43 + +/// +/// BottleKids3 provides improvements over BottleKids2 +module BottleKids3 = + let a = 44 + +/// BottleKids4 implements several new features over BottleKids3 +/// +module BottleKids4 = + let a = 45 + +/// +/// +/// BottleKids5 is all you'll ever need in terms of bottles or kids. +/// +module BottleKids5 = + let a = 46 +``` + +Note that the comments for `BottleKids3` (and `BottleKids4`) will generate a warning. This is because +the `` tag will be parsed as part of the `summary` text, and so the documentation generator +can't be completely sure you meant to exclude the item, or whether it was a valid part of the documentation. +It will assume the exclusion was intended, but you may want to use explicit `` tags to remove +the warning. + +The warning will be of the following format: + +```fsharp +Warning: detected "" in text of "" for "M:YourLib.BottleKids4". Please see https://fsprojects.github.io/FSharp.Formatting/apidocs.html#Classic-XML-Doc-Comments + +``` + +You will find that `[omit]` also works, but is considered part of the Markdown syntax and is +deprecated for XML Doc comments. This will also produce a warning, such as this: + +```fsharp +The use of `[omit]` and other commands in XML comments is deprecated, please use XML extensions, see https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md + +``` + +## Go to Source links + +'fsdocs' normally automatically adds GitHub links to each functions, values and class members for further reference. + +This is normally done automatically based on the following settings: + + https://github.com/... + ... + git + +If your source is not built from the same project where you are building documentation then +you may need these settings: + + ... -- the URL for the root of the source + ... -- the root soure folder at time of build + +It is assumed that `sourceRepo` and `sourceFolder` have synchronized contents. + +## Markdown Comments + +You can use Markdown instead of XML in `///` comments. If you do, you should set `true` in +your F# project file. + +> Note: Markdown Comments are not supported in all F# IDE tooling. +> + +### Adding cross-type links to modules and types in the same assembly + +You can automatically add cross-type links to the documentation pages of other modules and types in the same assembly. +You can do this in two different ways: + +* Add a [markdown inline link](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links) were the link +title is the name of the type you want to link. + + + ```fsharp + /// This will generate a link to [Foo.Bar] documentation + + ``` + + +* Add a [Markdown inline code](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code) (using +back-ticks) where the code is the name of the type you want to link. + + + ```fsharp + /// This will also generate a link to `Foo.Bar` documentation + + ``` + + +You can use either the full name (including namespace and module) or the simple name of a type. +If more than one type is found with the same name, the link will not be generated. +If a type with the given name is not found in the same assembly, the link will not be generated. + +```fsharp +/// Contains two types [Bar] and [Foo.Baz] +module Foo = + + /// Bar is just an `int` and belongs to module [Foo] + type Bar = int + + /// Baz contains a `Foo.Bar` as its `id` + type Baz = { id: Bar } + + /// This function operates on `Baz` types. + let f (b: Baz) = b.id * 42 + +/// Referencing [Foo3] will not generate a link as there is no type with the name `Foo3` +module Foo3 = + + /// This is not the same type as `Foo.Bar` + type Bar = double + + /// Using the simple name for [Bar] will fail to create a link because the name is duplicated in + /// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works. + let f2 b = b * 50 +``` + +### Markdown Comments: Excluding APIs from the docs + +If you want to exclude modules or functions from the API docs you can use the `[omit]` tag. +It needs to be set on a separate triple-slashed line, but it could be either the first or the last: + +Example as last line: + +```fsharp +/// Some actual comment +/// [omit] +module Bar = + let a = 42 +``` + +Example as the first line: + +```fsharp +/// [omit] +/// Some actual comment +module Bar2 = + let a = 42 +``` + +## Building library documentation programmatically + +You can build library documentation programmatically using the functionality +in the [ApiDocs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html) type. To do this, load the assembly and open the necessary namespaces: + +```fsharp +#r "FSharp.Formatting.ApiDocs.dll" + +open FSharp.Formatting.ApiDocs +open System.IO +``` + +For example the [ApiDocs.GenerateHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateHtml) method: + +```fsharp +let file = Path.Combine(root, "bin/YourLibrary.dll") + +let input = ApiDocInput.FromFile(file) + +ApiDocs.GenerateHtml( + [ input ], + output = Path.Combine(root, "output"), + collectionName = "YourLibrary", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [] +) +``` + +### Adding extra dependencies + +When building a library programmatically, you might require a reference to an additional assembly. +You can pass this using the `otherFlags` argument. + +```fsharp +let projectAssembly = Path.Combine(root, "bin/X.dll") + +let projectInput = ApiDocInput.FromFile(projectAssembly) + +ApiDocs.GenerateHtml( + [ projectInput ], + output = Path.Combine(root, "output"), + collectionName = "Project X", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [], + otherFlags = [ "-r:/root/ProjectY/bin/Debug/net6.0/Y.dll" ] +) +``` + +or use `libDirs` to include all assemblies from an entire folder. +Tip: A combination of `true` in the fsproj file and setting `libDirs` to the compilation output path leads to only one folder with all dependencies referenced. +This might be easier, especially for large projects with many dependencies. + +```fsharp +ApiDocs.GenerateHtml( + [ projectInput ], + output = Path.Combine(root, "output"), + collectionName = "Project X", + template = Path.Combine(root, "templates", "template.html"), + substitutions = [], + libDirs = [ "ProjectX/bin/Debug/netstandard2.0" ] +) +``` + +## Rebasing Links + +The `root` parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project's `` property. + +In some instances, you may wish to override the value for `root` (perhaps for local testing). To do this, you can use the command-line argument `--parameters root `. + +For example: + +dotnet fsdocs build --output public/docs --parameters root ../ + + diff --git a/apidocs.tex b/apidocs.tex new file mode 100644 index 000000000..238e9d5ae --- /dev/null +++ b/apidocs.tex @@ -0,0 +1,609 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + + + +\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=apidocs.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-binder.svg} +\caption{Binder} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//apidocs.fsx}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-script.svg} +\caption{Script} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//apidocs.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg} +\caption{Notebook} +\end{figure} +} +\section*{API Documentation Generation} + + + +The \href{commandline.html}{command-line tool \texttt{fsdocs}} can be used to generate documentation +for F\# libraries with XML comments. The documentation is normally built using \texttt{fsdocs build} and developed using \texttt{fsdocs watch}. For +the former the output will be placed in \texttt{output{\textbackslash}reference} by default. +\subsection*{Selected projects} + + + +\texttt{fsdocs} automatically selects the projects and "cracks" the project files for information +\begin{itemize} +\item Projects with \texttt{GenerateDocumentationFile} and without \texttt{IsTestProject} are selected. + +\item If Projects use \texttt{TargetFrameworks} (not \texttt{TargetFramework}, singular) only the firts target framework will be used to build the docs. + +\end{itemize} + +\begin{lstlisting} + + true + + +\end{lstlisting} +\subsection*{Templates} + + + +The HTML is built by instantiating a template. The template used is the first of: +\begin{itemize} +\item + +\texttt{docs/reference/\_template.html} + +\item + +\texttt{docs/\_template.html} + +\item + +The default template + +\end{itemize} + + + +Usually, the same template can be used as for \href{content.html}{other content}. +\subsection*{Classic XML Doc Comments} + + + +XML Doc Comments may use \href{https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/}{the normal F\# and C\# XML doc standards}. + + +The tags that form the core of the XML doc specification are: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +{<}\id{c}{>} {<}\id{para}{>} {<}\id{see}{>}{*} {<}\id{value}{>} +{<}\id{code}{>} {<}\id{param}{>}{*} {<}\id{seealso}{>}{*} +{<}\id{example}{>} {<}\id{paramref}{>} {<}\id{summary}{>} +{<}\kwd{exception}{>}{*} {<}\id{permission}{>}{*} {<}\id{typeparam}{>}{*} +{<}\id{include}{>}{*} {<}\id{remarks}{>} {<}\id{typeparamref}{>} +{<}\id{list}{>} {<}\id{inheritdoc}{>} {<}\id{returns}{>} + + +\end{lstlisting} + + + +In addition, you may also use the \href{https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md}{Recommended XML doc extensions for F\# documentation tooling}. +\begin{itemize} +\item + +\texttt{} links + +\item + +Arbitrary paragraph-level HTML such as \texttt{} for bold in XML doc text + +\item + +\texttt{} giving documentation for the enclosing namespace + +\item + +\texttt{} to exclude from XML docs + +\item + +\texttt{} to give a category for an entity or member. An optional \texttt{index} attribute can be specified +to help sort the list of categories. + +\item + +\texttt{{\textbackslash}(...{\textbackslash})} for inline math and \texttt{\$\$...\$\$} and \texttt{{\textbackslash}[...{\textbackslash}]}for math environments, see \href{http://docs.mathjax.org. +Some}{http://docs.mathjax.org. +Some} escaping of characters (e.g. \texttt{<}, \texttt{>}) may be needed to form valid XML + +\end{itemize} + + + +An example of an XML documentation comment, assuming the code is in the namespace \texttt{TheNamespace}: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// } +\com{/// A module} +\com{/// } +\com{///} +\com{/// } +\com{/// A namespace to remember} +\com{///} +\com{/// More on that} +\com{/// } +\com{///} +\kwd{module} \ltyp{SomeModule} \ops{=} + \com{/// } + \com{/// Some actual comment} + \com{/// Another paragraph, see . } + \com{/// } + \com{///} + \com{/// The input} + \com{///} + \com{/// The output} + \com{///} + \com{/// } + \com{/// Try using} + \com{/// } + \com{/// open TheNamespace} + \com{/// SomeModule.a} + \com{/// } + \com{/// } + \com{///} + \com{/// Foo} + \kwd{let} \lfun{someFunction} \lfun{x} \ops{=} \num{42} \ops{+} \lfun{x} + +\com{/// } +\com{/// A type, see and} +\com{/// .} +\com{/// } +\com{///} +\kwd{type} \ltyp{SomeType}{(}{)} \ops{=} + \kwd{member} \lfun{x}{.}{P} \ops{=} \num{1} + +\end{lstlisting} + + + +Like types, members are referred to by xml doc sig. These must currently be precise as the F\# +compiler doesn't elaborate these references from simpler names: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{type} \ltyp{Class2}{(}{)} \ops{=} + \kwd{member} \lfun{this}{.}{Property} \ops{=} \str{"more"} + \kwd{member} \lfun{this}{.}\lfun{Method0}{(}{)} \ops{=} \str{"more"} + \kwd{member} \lfun{this}{.}\lfun{Method1}{(}\lfun{c}{:} \ltyp{string}{)} \ops{=} \str{"more"} + \kwd{member} \lfun{this}{.}\lfun{Method2}{(}\lfun{c}{:} \ltyp{string}{,} \lfun{o}{:} \ltyp{obj}{)} \ops{=} \str{"more"} + +\com{/// } +\com{/// and } +\com{/// and } +\com{/// and } +\kwd{let} \lfun{referringFunction1} {(}{)} \ops{=} \str{"result"} + +\end{lstlisting} + + + +Generic types are referred to by .NET compiled name, e.g. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{type} \ltyp{GenericClass2}{<}{'}\id{T}{>}{(}{)} \ops{=} + \kwd{member} \lfun{this}{.}{Property} \ops{=} \str{"more"} + + \kwd{member} \lfun{this}{.}\lfun{NonGenericMethod}{(}\id{\_c}{:} {'}\id{T}{)} \ops{=} \str{"more"} + + \kwd{member} \lfun{this}{.}\lfun{GenericMethod}{(}\id{\_c}{:} {'}\id{T}{,} \id{\_o}{:} {'}\id{U}{)} \ops{=} \str{"more"} + +\com{/// See } +\com{/// and } +\com{/// and } +\com{/// and } +\kwd{let} \lfun{referringFunction2} {(}{)} \ops{=} \str{"result"} + +\end{lstlisting} + +\subsubsection*{Cross-referencing with } + + + +Use \texttt{} within \texttt{} to create cross-references. + + +For example: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{module} \ltyp{Forest} \ops{=} + + \com{/// } + \com{/// Find at most limit foxes in current forest} + \com{///} + \com{/// See also: } + \com{/// } + \kwd{let} \lfun{findFoxes} {(}\lfun{limit} {:} \ltyp{int}{)} \ops{=} {[}{]} + + \com{/// } + \com{/// Find at most limit squirrels in current forest} + \com{///} + \com{/// See also: } + \com{/// } + \kwd{let} \lfun{findSquirrels} {(}\lfun{limit} {:} \ltyp{int}{)} \ops{=} {[}{]} + +\end{lstlisting} + + + +You can find the correct value for \texttt{cref} in the generated \texttt{.xml} documentation file (this will be generated alongside the assembly's \texttt{.dll}`). + + +You can also omit the \texttt{cref}'s arguments, and \texttt{fsdocs} will make an attempt to find the first member that matches. + + +For example: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] + \com{/// See also: } + + +\end{lstlisting} + + + +If the member cannot be found, a link to the containing module/type will be used instead. +\subsubsection*{Classic XMl Doc Comments: Excluding APIs from the docs} + + + +If you want to exclude modules or functions from the API docs, you can use the \texttt{} tag. +It needs to be set on a separate triple-slashed line, and can either appear on its own or as part +of an existing \texttt{} (for example, you may wish to hide existing documentation while it's in progress). +The \texttt{} tag can be the first or last line in these cases. + + +Some examples: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// } +\kwd{module} \ltyp{BottleKids1} \ops{=} + \kwd{let} \id{a} \ops{=} \num{42} + +\com{// Ordinary comment} +\com{/// } +\kwd{module} \ltyp{BottleKids2} \ops{=} + \kwd{let} \id{a} \ops{=} \num{43} + +\com{/// } +\com{/// BottleKids3 provides improvements over BottleKids2} +\kwd{module} \ltyp{BottleKids3} \ops{=} + \kwd{let} \id{a} \ops{=} \num{44} + +\com{/// BottleKids4 implements several new features over BottleKids3} +\com{/// } +\kwd{module} \ltyp{BottleKids4} \ops{=} + \kwd{let} \id{a} \ops{=} \num{45} + +\com{/// } +\com{/// } +\com{/// BottleKids5 is all you'll ever need in terms of bottles or kids.} +\com{/// } +\kwd{module} \ltyp{BottleKids5} \ops{=} + \kwd{let} \id{a} \ops{=} \num{46} + +\end{lstlisting} + + + +Note that the comments for \texttt{BottleKids3} (and \texttt{BottleKids4}) will generate a warning. This is because +the \texttt{} tag will be parsed as part of the \texttt{summary} text, and so the documentation generator +can't be completely sure you meant to exclude the item, or whether it was a valid part of the documentation. +It will assume the exclusion was intended, but you may want to use explicit \texttt{} tags to remove +the warning. + + +The warning will be of the following format: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\id{Warning}{:} \id{detected} \str{""} \kwd{in} \id{text} \kwd{of} \str{""} \kwd{for} \str{"M:YourLib.BottleKids4"}{.} \id{Please} \id{see} \id{https}{:}\com{//fsprojects.github.io/FSharp.Formatting/apidocs.html\#Classic-XML-Doc-Comments} + + +\end{lstlisting} + + + +You will find that \texttt{[omit]} also works, but is considered part of the Markdown syntax and is +deprecated for XML Doc comments. This will also produce a warning, such as this: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\id{The} \kwd{use} \kwd{of} \id{`}{[}\id{omit}{]}\id{`} \kwd{and} \id{other} \id{commands} \kwd{in} \id{XML} \id{comments} \id{is} \id{deprecated}{,} \id{please} \kwd{use} \id{XML} \id{extensions}{,} \id{see} \id{https}{:}\com{//github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md} + + +\end{lstlisting} + +\subsection*{Go to Source links} + + + +'fsdocs' normally automatically adds GitHub links to each functions, values and class members for further reference. + + +This is normally done automatically based on the following settings: +\begin{lstlisting} + https://github.com/... + ... + git + +\end{lstlisting} + + +If your source is not built from the same project where you are building documentation then +you may need these settings: +\begin{lstlisting} + ... -- the URL for the root of the source + ... -- the root soure folder at time of build + +\end{lstlisting} + + +It is assumed that \texttt{sourceRepo} and \texttt{sourceFolder} have synchronized contents. +\subsection*{Markdown Comments} + + + +You can use Markdown instead of XML in \texttt{///} comments. If you do, you should set \texttt{true} in +your F\# project file. +\begin{quote} + + +Note: Markdown Comments are not supported in all F\# IDE tooling. +\end{quote} + +\subsubsection*{Adding cross-type links to modules and types in the same assembly} + + + +You can automatically add cross-type links to the documentation pages of other modules and types in the same assembly. +You can do this in two different ways: +\begin{itemize} +\item + +Add a \href{https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet\#links}{markdown inline link} were the link +title is the name of the type you want to link. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// This will generate a link to [Foo.Bar] documentation} + + +\end{lstlisting} + + +\item + +Add a \href{https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet\#code}{Markdown inline code} (using +back-ticks) where the code is the name of the type you want to link. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// This will also generate a link to `Foo.Bar` documentation} + + +\end{lstlisting} + + +\end{itemize} + + + +You can use either the full name (including namespace and module) or the simple name of a type. +If more than one type is found with the same name, the link will not be generated. +If a type with the given name is not found in the same assembly, the link will not be generated. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// Contains two types [Bar] and [Foo.Baz]} +\kwd{module} \ltyp{Foo} \ops{=} + + \com{/// Bar is just an `int` and belongs to module [Foo]} + \kwd{type} \ltyp{Bar} \ops{=} \ltyp{int} + + \com{/// Baz contains a `Foo.Bar` as its `id`} + \kwd{type} \ltyp{Baz} \ops{=} {\{} {id}{:} \ltyp{Bar} {\}} + + \com{/// This function operates on `Baz` types.} + \kwd{let} \lfun{f} {(}\lfun{b}{:} \ltyp{Baz}{)} \ops{=} \lfun{b}{.}\id{id} \ops{*} \num{42} + +\com{/// Referencing [Foo3] will not generate a link as there is no type with the name `Foo3`} +\kwd{module} \ltyp{Foo3} \ops{=} + + \com{/// This is not the same type as `Foo.Bar`} + \kwd{type} \ltyp{Bar} \ops{=} \ltyp{double} + + \com{/// Using the simple name for [Bar] will fail to create a link because the name is duplicated in} + \com{/// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works.} + \kwd{let} \lfun{f2} \lfun{b} \ops{=} \lfun{b} \ops{*} \num{50} + +\end{lstlisting} + +\subsubsection*{Markdown Comments: Excluding APIs from the docs} + + + +If you want to exclude modules or functions from the API docs you can use the \texttt{[omit]} tag. +It needs to be set on a separate triple-slashed line, but it could be either the first or the last: + + +Example as last line: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// Some actual comment} +\com{/// [omit]} +\kwd{module} \ltyp{Bar} \ops{=} + \kwd{let} \id{a} \ops{=} \num{42} + +\end{lstlisting} + + + +Example as the first line: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{/// [omit]} +\com{/// Some actual comment} +\kwd{module} \ltyp{Bar2} \ops{=} + \kwd{let} \id{a} \ops{=} \num{42} + +\end{lstlisting} + +\subsection*{Building library documentation programmatically} + + + +You can build library documentation programmatically using the functionality +in the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html}{ApiDocs} type. To do this, load the assembly and open the necessary namespaces: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\prep{\#r} \str{"FSharp.Formatting.ApiDocs.dll"} + +\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{ApiDocs} +\kwd{open} \id{System}{.}\id{IO} + +\end{lstlisting} + + + +For example the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html\#GenerateHtml}{ApiDocs.GenerateHtml} method: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{file} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"bin/YourLibrary.dll"}{)} + +\kwd{let} \id{input} \ops{=} \ltyp{ApiDocInput}{.}\id{FromFile}{(}\id{file}{)} + +\ltyp{ApiDocs}{.}\id{GenerateHtml}{(} + {[} \id{input} {]}{,} + \lfun{output} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"output"}{)}{,} + \lfun{collectionName} \ops{=} \str{"YourLibrary"}{,} + \lfun{template} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"templates"}{,} \str{"template.html"}{)}{,} + \lfun{substitutions} \ops{=} {[}{]} +{)} + +\end{lstlisting} + +\subsubsection*{Adding extra dependencies} + + + +When building a library programmatically, you might require a reference to an additional assembly. +You can pass this using the \texttt{otherFlags} argument. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{projectAssembly} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"bin/X.dll"}{)} + +\kwd{let} \id{projectInput} \ops{=} \ltyp{ApiDocInput}{.}\id{FromFile}{(}\id{projectAssembly}{)} + +\ltyp{ApiDocs}{.}\id{GenerateHtml}{(} + {[} \id{projectInput} {]}{,} + \lfun{output} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"output"}{)}{,} + \lfun{collectionName} \ops{=} \str{"Project X"}{,} + \lfun{template} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"templates"}{,} \str{"template.html"}{)}{,} + \lfun{substitutions} \ops{=} {[}{]}{,} + \lfun{otherFlags} \ops{=} {[} \str{"-r:/root/ProjectY/bin/Debug/net6.0/Y.dll"} {]} +{)} + +\end{lstlisting} + + + +or use \texttt{libDirs} to include all assemblies from an entire folder. +Tip: A combination of \texttt{true} in the fsproj file and setting \texttt{libDirs} to the compilation output path leads to only one folder with all dependencies referenced. +This might be easier, especially for large projects with many dependencies. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\ltyp{ApiDocs}{.}\id{GenerateHtml}{(} + {[} \id{projectInput} {]}{,} + \lfun{output} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"output"}{)}{,} + \lfun{collectionName} \ops{=} \str{"Project X"}{,} + \lfun{template} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{root}{,} \str{"templates"}{,} \str{"template.html"}{)}{,} + \lfun{substitutions} \ops{=} {[}{]}{,} + \lfun{libDirs} \ops{=} {[} \str{"ProjectX/bin/Debug/netstandard2.0"} {]} +{)} + +\end{lstlisting} + +\subsection*{Rebasing Links} + + + +The \texttt{root} parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project's \texttt{} property. + + +In some instances, you may wish to override the value for \texttt{root} (perhaps for local testing). To do this, you can use the command-line argument \texttt{--parameters root }. + + +For example: +\begin{lstlisting} +dotnet fsdocs build --output public/docs --parameters root ../ + +\end{lstlisting} + + +\end{document} \ No newline at end of file diff --git a/codeformat.fsx b/codeformat.fsx new file mode 100644 index 000000000..a0cd32ffe --- /dev/null +++ b/codeformat.fsx @@ -0,0 +1,138 @@ +(** + +*) +#r "nuget: FSharp.Formatting,1.0.0" +(** +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=codeformat.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.ipynb) + +# Code formatting + +This page demonstrates how to use `FSharp.Formatting.CodeFormat` to tokenize +F# source code, obtain information about the source code (mainly tooltips +from the type-checker) and how to turn the code into a nicely formatted HTML. + +First, we need to load the assembly and open the necessary namespaces: + +*) +open FSharp.Formatting.CodeFormat +open System.Reflection +(** +If you want to process multiple snippets, it is a good idea to keep the +formatting agent around if possible. The agent needs to load the F# compiler +(which needs to load various files itself) and so this takes a long time. + +## Processing F# source + +The formatting agent provides a [CodeFormatAgent.ParseAndCheckSource](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-formatting-codeformat-codeformatagent#ParseAndCheckSource) method (together with an asynchronous +version for use from F# and also a version that returns a .NET `Task` for C#). +To call the method, we define a simple F# code as a string: + +*) +let source = + """ + let hello () = + printfn "Hello world" + """ + +let snippets, diagnostics = + CodeFormatter.ParseAndCheckSource("C:\\snippet.fsx", source, None, None, ignore) +(** +When calling the method, you need to specify a file name and the actual content +of the script file. The file does not have to physically exist. It is used by the +F# compiler to resolve relative references (e.g. `#r`) and to automatically name +the module including all code in the file. + +You can also specify additional parameters, such as `*.dll` references, by passing +a third argument with compiler options (e.g. `"-r:Foo.dll -r:Bar.dll"`). + +This operation might take some time, so it is a good idea to use an asynchronous +variant of the method. It returns two arrays - the first contains F# snippets +in the source code and the second contains any errors reported by the compiler. +A single source file can include multiple snippets using the same formatting tags +as those used on [fssnip.net](http://www.fssnip.net) as documented in the +[about page](http://www.fssnip.net/pages/About). + +## Working with returned tokens + +Each returned snippet is essentially just a collection of lines, and each line +consists of a sequence of tokens. The following snippet prints basic information +about the tokens of our sample snippet: + +*) +// Get the first snippet and obtain list of lines +let (Snippet (title, lines)) = snippets |> Seq.head + +// Iterate over all lines and all tokens on each line +for (Line (_, tokens)) in lines do + for token in tokens do + match token with + | TokenSpan.Token (kind, code, tip) -> + printf "%s" code + + tip + |> Option.iter (fun spans -> printfn "%A" spans) + | TokenSpan.Omitted _ + | TokenSpan.Output _ + | TokenSpan.Error _ -> () + + printfn "" +(** +The `TokenSpan.Token` is the most important kind of token. It consists of a kind +(identifier, keyword, etc.), the original F# code and tooltip information. +The tooltip is further formatted using a simple document format, but we simply +print the value using the F# pretty printing, so the result looks as follows: + + let hello[Literal "val hello : unit -> unit"; ...] () = + printfn[Literal "val printfn : TextWriterFormat<'T> -> 'T"; ...] "Hello world" + +The `Omitted` token is generated if you use the special `(*[omit:...]*)` command. +The `Output` token is generated if you use the `// [fsi:...]` command to format +output returned by F# interactive. The `Error` command wraps code that should be +underlined with a red squiggle if the code contains an error. + +## Generating HTML output + +Finally, the `CodeFormat` type also includes a method [CodeFormat.FormatHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatHtml) that can be used +to generate nice HTML output from an F# snippet. This is used, for example, on +[F# Snippets](http://www.fssnip.net). The following example shows how to call it: + +*) +let prefix = "fst" +let html = CodeFormat.FormatHtml(snippets, prefix) + +// Print all snippets, in case there is more of them +for snip in html.Snippets do + printfn "%s" snip.Content + +// Print HTML code that is generated for ToolTips +printfn "%s" html.ToolTip +(** +If the input contains multiple snippets separated using the `//[snippet:...]` comment, e.g.: + + + + +
    +1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    +
    // [snippet: First sample]
+printf "The answer is: %A" 42
+// [/snippet]
+// [snippet: Second sample]
+printf "Hello world!"
+// [/snippet]
+
    +
    +then the formatter returns multiple HTML blocks. However, the generated tooltips +are shared by all snippets (to save space) and so they are returned separately. + +*) + diff --git a/codeformat.html b/codeformat.html new file mode 100644 index 000000000..f9b06ac42 --- /dev/null +++ b/codeformat.html @@ -0,0 +1,528 @@ + + + + + + + + + + + + + + + + + + Code formatting + | FSharp.Formatting + + + + + + + + + + + + + +
    +
    + + + Header menu logo + FSharp.Formatting + +
    +
    + + + + + +
    +
    + +
    +
    + +

    Binder  +Script  +Notebook

    +

    Code formatting

    +

    This page demonstrates how to use FSharp.Formatting.CodeFormat to tokenize +F# source code, obtain information about the source code (mainly tooltips +from the type-checker) and how to turn the code into a nicely formatted HTML.

    +

    First, we need to load the assembly and open the necessary namespaces:

    +
    open FSharp.Formatting.CodeFormat
+open System.Reflection
+
    +

    If you want to process multiple snippets, it is a good idea to keep the +formatting agent around if possible. The agent needs to load the F# compiler +(which needs to load various files itself) and so this takes a long time.

    +

    Processing F# source

    +

    The formatting agent provides a CodeFormatAgent.ParseAndCheckSource method (together with an asynchronous +version for use from F# and also a version that returns a .NET Task for C#). +To call the method, we define a simple F# code as a string:

    +
    let source =
+    """
+    let hello () =
+      printfn "Hello world"
+  """
+
+let snippets, diagnostics =
+    CodeFormatter.ParseAndCheckSource("C:\\snippet.fsx", source, None, None, ignore)
+
    +

    When calling the method, you need to specify a file name and the actual content +of the script file. The file does not have to physically exist. It is used by the +F# compiler to resolve relative references (e.g. #r) and to automatically name +the module including all code in the file.

    +

    You can also specify additional parameters, such as *.dll references, by passing +a third argument with compiler options (e.g. "-r:Foo.dll -r:Bar.dll").

    +

    This operation might take some time, so it is a good idea to use an asynchronous +variant of the method. It returns two arrays - the first contains F# snippets +in the source code and the second contains any errors reported by the compiler. +A single source file can include multiple snippets using the same formatting tags +as those used on fssnip.net as documented in the +about page.

    +

    Working with returned tokens

    +

    Each returned snippet is essentially just a collection of lines, and each line +consists of a sequence of tokens. The following snippet prints basic information +about the tokens of our sample snippet:

    +
    // Get the first snippet and obtain list of lines
+let (Snippet (title, lines)) = snippets |> Seq.head
+
+// Iterate over all lines and all tokens on each line
+for (Line (_, tokens)) in lines do
+    for token in tokens do
+        match token with
+        | TokenSpan.Token (kind, code, tip) ->
+            printf "%s" code
+
+            tip
+            |> Option.iter (fun spans -> printfn "%A" spans)
+        | TokenSpan.Omitted _
+        | TokenSpan.Output _
+        | TokenSpan.Error _ -> ()
+
+    printfn ""
+
    +

    The TokenSpan.Token is the most important kind of token. It consists of a kind +(identifier, keyword, etc.), the original F# code and tooltip information. +The tooltip is further formatted using a simple document format, but we simply +print the value using the F# pretty printing, so the result looks as follows:

    +
    let hello[Literal "val hello : unit -> unit"; ...] () =
+  printfn[Literal "val printfn : TextWriterFormat<'T> -> 'T"; ...] "Hello world"
+
    +

    The Omitted token is generated if you use the special (*[omit:...]*) command. +The Output token is generated if you use the // [fsi:...] command to format +output returned by F# interactive. The Error command wraps code that should be +underlined with a red squiggle if the code contains an error.

    +

    Generating HTML output

    +

    Finally, the CodeFormat type also includes a method CodeFormat.FormatHtml that can be used +to generate nice HTML output from an F# snippet. This is used, for example, on +F# Snippets. The following example shows how to call it:

    +
    let prefix = "fst"
+let html = CodeFormat.FormatHtml(snippets, prefix)
+
+// Print all snippets, in case there is more of them
+for snip in html.Snippets do
+    printfn "%s" snip.Content
+
+// Print HTML code that is generated for ToolTips
+printfn "%s" html.ToolTip
+
    +

    If the input contains multiple snippets separated using the //[snippet:...] comment, e.g.:

    + + + +
    +1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
    +
    // [snippet: First sample]
+printf "The answer is: %A" 42
+// [/snippet]
+// [snippet: Second sample]
+printf "Hello world!"
+// [/snippet]
+
    +
    +

    then the formatter returns multiple HTML blocks. However, the generated tooltips +are shared by all snippets (to save space) and so they are returned separately.

    + +
    Multiple items
    namespace FSharp

    --------------------
    namespace Microsoft.FSharp
    +
    namespace FSharp.Formatting
    +
    namespace FSharp.Formatting.CodeFormat
    +
    namespace System
    +
    namespace System.Reflection
    +
    val source: string
    +
    val snippets: Snippet array
    +
    val diagnostics: SourceError array
    +
    module CodeFormatter + +from FSharp.Formatting.CodeFormat
    <summary> + Uses agent to handle formatting requests +</summary>
    +
    val ParseAndCheckSource: file: string * source: string * options: string option * defines: string option * onError: (string -> unit) -> Snippet array * SourceError array
    <summary> + Parse, check and annotate the source code specified by 'source', assuming that it + is located in a specified 'file'. Optional arguments can be used + to give compiler command line options and preprocessor definitions +</summary>
    +
    union case Option.None: Option<'T>
    +
    val ignore: value: 'T -> unit
    +
    Multiple items
    union case Snippet.Snippet: title: string * lines: Line list -> Snippet

    --------------------
    type Snippet = | Snippet of title: string * lines: Line list
    <summary> + An F# snippet consists of a snippet title and a list of lines +</summary>
    +
    val title: string
    +
    val lines: Line list
    +
    module Seq + +from Microsoft.FSharp.Collections
    +
    val head: source: 'T seq -> 'T
    +
    Multiple items
    union case Line.Line: originalLine: string * tokenSpans: TokenSpans -> Line

    --------------------
    type Line = | Line of originalLine: string * tokenSpans: TokenSpans
    <summary> + Represents a line of source code as a list of TokenSpan values. This is + a single case discriminated union with Line constructor. +</summary>
    +
    val tokens: TokenSpans
    +
    val token: TokenSpan
    +
    type TokenSpan = + | Token of kind: TokenKind * body: string * tip: ToolTipSpans option + | Error of kind: ErrorKind * message: string * body: TokenSpans + | Omitted of body: string * hidden: string + | Output of string
    <summary> + A token in a parsed F# code snippet. Aside from standard tokens reported from + the compiler (Token), this also includes Error (wrapping the underlined + tokens), Omitted for the special [omit:...] tags and Output for the special [output:...] tag +</summary>
    +
    union case TokenSpan.Token: kind: TokenKind * body: string * tip: ToolTipSpans option -> TokenSpan
    +
    val kind: TokenKind
    +
    val code: string
    +
    val tip: ToolTipSpans option
    +
    val printf: format: Printf.TextWriterFormat<'T> -> 'T
    +
    module Option + +from Microsoft.FSharp.Core
    +
    val iter: action: ('T -> unit) -> option: 'T option -> unit
    +
    val spans: ToolTipSpans
    +
    val printfn: format: Printf.TextWriterFormat<'T> -> 'T
    +
    union case TokenSpan.Omitted: body: string * hidden: string -> TokenSpan
    +
    union case TokenSpan.Output: string -> TokenSpan
    +
    union case TokenSpan.Error: kind: ErrorKind * message: string * body: TokenSpans -> TokenSpan
    +
    Multiple items
    type LiteralAttribute = + inherit Attribute + new: unit -> LiteralAttribute

    --------------------
    new: unit -> LiteralAttribute
    +
    val prefix: string
    +
    val html: FormattedContent
    +
    type CodeFormat = + static member FormatFsx: snippets: Snippet seq -> FormattedContent + static member FormatHtml: snippets: Snippet array * prefix: string * ?openTag: string * ?closeTag: string * ?lineNumbers: bool * ?openLinesTag: string * ?closeLinesTag: string * ?addErrors: bool * ?tokenKindToCss: (TokenKind -> string) -> FormattedContent + static member FormatLatex: snippets: Snippet array * ?openTag: string * ?closeTag: string * ?lineNumbers: bool -> FormattedContent
    <summary> + Exposes functionality of the F# code formatter with a nice interface +</summary>
    +
    static member CodeFormat.FormatHtml: snippets: Snippet array * prefix: string * ?openTag: string * ?closeTag: string * ?lineNumbers: bool * ?openLinesTag: string * ?closeLinesTag: string * ?addErrors: bool * ?tokenKindToCss: (TokenKind -> string) -> FormattedContent
    +
    val snip: FormattedSnippet
    +
    property FormattedContent.Snippets: FormattedSnippet array with get
    <summary> + Returns the processed snippets as an array +</summary>
    +
    property FormattedSnippet.Content: string with get
    <summary> + Returns the formatted content code for the snipet +</summary>
    +
    property FormattedContent.ToolTip: string with get
    <summary> + Returns string with ToolTip elements for all the snippets +</summary>
    + +
    +
    + + + +
    +
      +

      Type something to start searching.

      +
      +       + + + + + + + + \ No newline at end of file diff --git a/codeformat.ipynb b/codeformat.ipynb new file mode 100644 index 000000000..f50431086 --- /dev/null +++ b/codeformat.ipynb @@ -0,0 +1,318 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "#r \"nuget: FSharp.Formatting,1.0.0\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=codeformat.ipynb)\u0026emsp;\n", + "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.fsx)\u0026emsp;\n", + "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.ipynb)\n", + "\n", + "# Code formatting\n", + "\n", + "This page demonstrates how to use `FSharp.Formatting.CodeFormat` to tokenize\n", + "F# source code, obtain information about the source code (mainly tooltips\n", + "from the type-checker) and how to turn the code into a nicely formatted HTML.\n", + "\n", + "First, we need to load the assembly and open the necessary namespaces:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "open FSharp.Formatting.CodeFormat\n", + "open System.Reflection\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "If you want to process multiple snippets, it is a good idea to keep the\n", + "formatting agent around if possible. The agent needs to load the F# compiler\n", + "(which needs to load various files itself) and so this takes a long time.\n", + "\n", + "## Processing F# source\n", + "\n", + "The formatting agent provides a [CodeFormatAgent.ParseAndCheckSource](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-formatting-codeformat-codeformatagent#ParseAndCheckSource) method (together with an asynchronous\n", + "version for use from F# and also a version that returns a .NET `Task` for C#).\n", + "To call the method, we define a simple F# code as a string:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "let source =\n", + " \"\"\"\n", + " let hello () =\n", + " printfn \"Hello world\"\n", + " \"\"\"\n", + "\n", + "let snippets, diagnostics =\n", + " CodeFormatter.ParseAndCheckSource(\"C:\\\\snippet.fsx\", source, None, None, ignore)\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "When calling the method, you need to specify a file name and the actual content\n", + "of the script file. The file does not have to physically exist. It is used by the\n", + "F# compiler to resolve relative references (e.g. `#r`) and to automatically name\n", + "the module including all code in the file.\n", + "\n", + "You can also specify additional parameters, such as `*.dll` references, by passing\n", + "a third argument with compiler options (e.g. `\"-r:Foo.dll -r:Bar.dll\"`).\n", + "\n", + "This operation might take some time, so it is a good idea to use an asynchronous\n", + "variant of the method. It returns two arrays - the first contains F# snippets\n", + "in the source code and the second contains any errors reported by the compiler.\n", + "A single source file can include multiple snippets using the same formatting tags\n", + "as those used on [fssnip.net](http://www.fssnip.net) as documented in the\n", + "[about page](http://www.fssnip.net/pages/About).\n", + "\n", + "## Working with returned tokens\n", + "\n", + "Each returned snippet is essentially just a collection of lines, and each line\n", + "consists of a sequence of tokens. The following snippet prints basic information\n", + "about the tokens of our sample snippet:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "// Get the first snippet and obtain list of lines\n", + "let (Snippet (title, lines)) = snippets |\u003e Seq.head\n", + "\n", + "// Iterate over all lines and all tokens on each line\n", + "for (Line (_, tokens)) in lines do\n", + " for token in tokens do\n", + " match token with\n", + " | TokenSpan.Token (kind, code, tip) -\u003e\n", + " printf \"%s\" code\n", + "\n", + " tip\n", + " |\u003e Option.iter (fun spans -\u003e printfn \"%A\" spans)\n", + " | TokenSpan.Omitted _\n", + " | TokenSpan.Output _\n", + " | TokenSpan.Error _ -\u003e ()\n", + "\n", + " printfn \"\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "The `TokenSpan.Token` is the most important kind of token. It consists of a kind\n", + "(identifier, keyword, etc.), the original F# code and tooltip information.\n", + "The tooltip is further formatted using a simple document format, but we simply\n", + "print the value using the F# pretty printing, so the result looks as follows:\n", + "\n", + " let hello[Literal \"val hello : unit -\u003e unit\"; ...] () =\n", + " printfn[Literal \"val printfn : TextWriterFormat\u003c\u0027T\u003e -\u003e \u0027T\"; ...] \"Hello world\"\n", + "\n", + "The `Omitted` token is generated if you use the special `(*[omit:...]*)` command.\n", + "The `Output` token is generated if you use the `// [fsi:...]` command to format\n", + "output returned by F# interactive. The `Error` command wraps code that should be\n", + "underlined with a red squiggle if the code contains an error.\n", + "\n", + "## Generating HTML output\n", + "\n", + "Finally, the `CodeFormat` type also includes a method [CodeFormat.FormatHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatHtml) that can be used\n", + "to generate nice HTML output from an F# snippet. This is used, for example, on\n", + "[F# Snippets](http://www.fssnip.net). The following example shows how to call it:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "let prefix = \"fst\"\n", + "let html = CodeFormat.FormatHtml(snippets, prefix)\n", + "\n", + "// Print all snippets, in case there is more of them\n", + "for snip in html.Snippets do\n", + " printfn \"%s\" snip.Content\n", + "\n", + "// Print HTML code that is generated for ToolTips\n", + "printfn \"%s\" html.ToolTip\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "If the input contains multiple snippets separated using the `//[snippet:...]` comment, e.g.:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "\u003ctable class=\"pre\"\u003e\u003ctr\u003e\u003ctd class=\"lines\"\u003e\u003cpre class=\"fssnip\"\u003e\n", + "\u003cspan class=\"l\"\u003e1: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e2: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e3: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e4: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e5: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e6: \u003c/span\u003e\n", + "\u003cspan class=\"l\"\u003e7: \u003c/span\u003e\n", + "\u003c/pre\u003e\n", + "\u003c/td\u003e\n", + "\u003ctd class=\"snippet\"\u003e\u003cpre class=\"fssnip\"\u003e\u003cspan class=\"c\"\u003e// [snippet: First sample]\u003c/span\u003e\n", + "\u003cspan class=\"i\"\u003eprintf\u003c/span\u003e \u003cspan class=\"s\"\u003e\"The answer is: %A\"\u003c/span\u003e \u003cspan class=\"n\"\u003e42\u003c/span\u003e\n", + "\u003cspan class=\"c\"\u003e// [/snippet]\u003c/span\u003e\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "\u003cspan class=\"c\"\u003e// [snippet: Second sample]\u003c/span\u003e\n", + "\u003cspan class=\"i\"\u003eprintf\u003c/span\u003e \u003cspan class=\"s\"\u003e\"Hello world!\"\u003c/span\u003e\n", + "\u003cspan class=\"c\"\u003e// [/snippet]\u003c/span\u003e\n", + "\u003c/pre\u003e\n", + "\u003c/td\u003e\n", + "\u003c/tr\u003e\n", + "\u003c/table\u003e\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "then the formatter returns multiple HTML blocks. However, the generated tooltips\n", + "are shared by all snippets (to save space) and so they are returned separately.\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/codeformat.md b/codeformat.md new file mode 100644 index 000000000..51d09d66a --- /dev/null +++ b/codeformat.md @@ -0,0 +1,139 @@ +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=codeformat.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//codeformat.ipynb) + +# Code formatting + +This page demonstrates how to use `FSharp.Formatting.CodeFormat` to tokenize +F# source code, obtain information about the source code (mainly tooltips +from the type-checker) and how to turn the code into a nicely formatted HTML. + +First, we need to load the assembly and open the necessary namespaces: + +```fsharp +open FSharp.Formatting.CodeFormat +open System.Reflection +``` + +If you want to process multiple snippets, it is a good idea to keep the +formatting agent around if possible. The agent needs to load the F# compiler +(which needs to load various files itself) and so this takes a long time. + +## Processing F# source + +The formatting agent provides a [CodeFormatAgent.ParseAndCheckSource](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-formatting-codeformat-codeformatagent#ParseAndCheckSource) method (together with an asynchronous +version for use from F# and also a version that returns a .NET `Task` for C#). +To call the method, we define a simple F# code as a string: + +```fsharp +let source = + """ + let hello () = + printfn "Hello world" + """ + +let snippets, diagnostics = + CodeFormatter.ParseAndCheckSource("C:\\snippet.fsx", source, None, None, ignore) +``` + +When calling the method, you need to specify a file name and the actual content +of the script file. The file does not have to physically exist. It is used by the +F# compiler to resolve relative references (e.g. `#r`) and to automatically name +the module including all code in the file. + +You can also specify additional parameters, such as `*.dll` references, by passing +a third argument with compiler options (e.g. `"-r:Foo.dll -r:Bar.dll"`). + +This operation might take some time, so it is a good idea to use an asynchronous +variant of the method. It returns two arrays - the first contains F# snippets +in the source code and the second contains any errors reported by the compiler. +A single source file can include multiple snippets using the same formatting tags +as those used on [fssnip.net](http://www.fssnip.net) as documented in the +[about page](http://www.fssnip.net/pages/About). + +## Working with returned tokens + +Each returned snippet is essentially just a collection of lines, and each line +consists of a sequence of tokens. The following snippet prints basic information +about the tokens of our sample snippet: + +```fsharp +// Get the first snippet and obtain list of lines +let (Snippet (title, lines)) = snippets |> Seq.head + +// Iterate over all lines and all tokens on each line +for (Line (_, tokens)) in lines do + for token in tokens do + match token with + | TokenSpan.Token (kind, code, tip) -> + printf "%s" code + + tip + |> Option.iter (fun spans -> printfn "%A" spans) + | TokenSpan.Omitted _ + | TokenSpan.Output _ + | TokenSpan.Error _ -> () + + printfn "" +``` + +The `TokenSpan.Token` is the most important kind of token. It consists of a kind +(identifier, keyword, etc.), the original F# code and tooltip information. +The tooltip is further formatted using a simple document format, but we simply +print the value using the F# pretty printing, so the result looks as follows: + +```fsharp +let hello[Literal "val hello : unit -> unit"; ...] () = + printfn[Literal "val printfn : TextWriterFormat<'T> -> 'T"; ...] "Hello world" + +``` + +The `Omitted` token is generated if you use the special `(*[omit:...]*)` command. +The `Output` token is generated if you use the `// [fsi:...]` command to format +output returned by F# interactive. The `Error` command wraps code that should be +underlined with a red squiggle if the code contains an error. + +## Generating HTML output + +Finally, the `CodeFormat` type also includes a method [CodeFormat.FormatHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatHtml) that can be used +to generate nice HTML output from an F# snippet. This is used, for example, on +[F# Snippets](http://www.fssnip.net). The following example shows how to call it: + +```fsharp +let prefix = "fst" +let html = CodeFormat.FormatHtml(snippets, prefix) + +// Print all snippets, in case there is more of them +for snip in html.Snippets do + printfn "%s" snip.Content + +// Print HTML code that is generated for ToolTips +printfn "%s" html.ToolTip +``` + +If the input contains multiple snippets separated using the `//[snippet:...]` comment, e.g.: + + + + +
      +1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
      +
      // [snippet: First sample]
+printf "The answer is: %A" 42
+// [/snippet]
+// [snippet: Second sample]
+printf "Hello world!"
+// [/snippet]
+
      +
      +then the formatter returns multiple HTML blocks. However, the generated tooltips +are shared by all snippets (to save space) and so they are returned separately. + + diff --git a/codeformat.tex b/codeformat.tex new file mode 100644 index 000000000..cbf2203dc --- /dev/null +++ b/codeformat.tex @@ -0,0 +1,228 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + + + +\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=codeformat.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-binder.svg} +\caption{Binder} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//codeformat.fsx}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-script.svg} +\caption{Script} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//codeformat.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg} +\caption{Notebook} +\end{figure} +} +\section*{Code formatting} + + + +This page demonstrates how to use \texttt{FSharp.Formatting.CodeFormat} to tokenize +F\# source code, obtain information about the source code (mainly tooltips +from the type-checker) and how to turn the code into a nicely formatted HTML. + + +First, we need to load the assembly and open the necessary namespaces: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{CodeFormat} +\kwd{open} \id{System}{.}\id{Reflection} + +\end{lstlisting} + + + +If you want to process multiple snippets, it is a good idea to keep the +formatting agent around if possible. The agent needs to load the F\# compiler +(which needs to load various files itself) and so this takes a long time. +\subsection*{Processing F\# source} + + + +The formatting agent provides a \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-formatting-codeformat-codeformatagent\#ParseAndCheckSource}{CodeFormatAgent.ParseAndCheckSource} method (together with an asynchronous +version for use from F\# and also a version that returns a .NET \texttt{Task} for C\#). +To call the method, we define a simple F\# code as a string: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{source} \ops{=} + \str{"""} +\str{ let hello () =} +\str{ printfn "Hello world"} +\str{ """} + +\kwd{let} \id{snippets}{,} \id{diagnostics} \ops{=} + \ltyp{CodeFormatter}{.}\id{ParseAndCheckSource}{(}\str{"C:{\textbackslash}{\textbackslash}snippet.fsx"}{,} \id{source}{,} {None}{,} {None}{,} \lfun{ignore}{)} + +\end{lstlisting} + + + +When calling the method, you need to specify a file name and the actual content +of the script file. The file does not have to physically exist. It is used by the +F\# compiler to resolve relative references (e.g. \texttt{\#r}) and to automatically name +the module including all code in the file. + + +You can also specify additional parameters, such as \texttt{*.dll} references, by passing +a third argument with compiler options (e.g. \texttt{"-r:Foo.dll -r:Bar.dll"}). + + +This operation might take some time, so it is a good idea to use an asynchronous +variant of the method. It returns two arrays - the first contains F\# snippets +in the source code and the second contains any errors reported by the compiler. +A single source file can include multiple snippets using the same formatting tags +as those used on \href{http://www.fssnip.net}{fssnip.net} as documented in the +\href{http://www.fssnip.net/pages/About}{about page}. +\subsection*{Working with returned tokens} + + + +Each returned snippet is essentially just a collection of lines, and each line +consists of a sequence of tokens. The following snippet prints basic information +about the tokens of our sample snippet: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{// Get the first snippet and obtain list of lines} +\kwd{let} {(}{Snippet} {(}\id{title}{,} \id{lines}{)}{)} \ops{=} \id{snippets} \ops{|>} \ltyp{Seq}{.}\id{head} + +\com{// Iterate over all lines and all tokens on each line} +\kwd{for} {(}{Line} {(}\id{\_}{,} \lfun{tokens}{)}{)} \kwd{in} \id{lines} \kwd{do} + \kwd{for} \lfun{token} \kwd{in} \lfun{tokens} \kwd{do} + \kwd{match} \lfun{token} \kwd{with} + {|} \ltyp{TokenSpan}{.}\id{Token} {(}\lfun{kind}{,} \lfun{code}{,} \lfun{tip}{)} \kwd{->} + \lfun{printf} \str{"}\lprf{\%s}\str{"} \lfun{code} + + \lfun{tip} + \ops{|>} \ltyp{Option}{.}\id{iter} {(}\kwd{fun} \lfun{spans} \kwd{->} \lfun{printfn} \str{"}\lprf{\%A}\str{"} \lfun{spans}{)} + {|} \ltyp{TokenSpan}{.}\id{Omitted} \id{\_} + {|} \ltyp{TokenSpan}{.}\id{Output} \id{\_} + {|} \ltyp{TokenSpan}{.}\id{Error} \id{\_} \kwd{->} {(}{)} + + \lfun{printfn} \str{""} + +\end{lstlisting} + + + +The \texttt{TokenSpan.Token} is the most important kind of token. It consists of a kind +(identifier, keyword, etc.), the original F\# code and tooltip information. +The tooltip is further formatted using a simple document format, but we simply +print the value using the F\# pretty printing, so the result looks as follows: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{hello}{[}\id{Literal} \str{"val hello : unit -> unit"}{;} \ops{..}{.}{]} {(}{)} \ops{=} + \id{printfn}{[}\id{Literal} \str{"val printfn : TextWriterFormat<'T> -> 'T"}{;} \ops{..}{.}{]} \str{"Hello world"} + + +\end{lstlisting} + + + +The \texttt{Omitted} token is generated if you use the special \texttt{(*[omit:...]*)} command. +The \texttt{Output} token is generated if you use the \texttt{// [fsi:...]} command to format +output returned by F\# interactive. The \texttt{Error} command wraps code that should be +underlined with a red squiggle if the code contains an error. +\subsection*{Generating HTML output} + + + +Finally, the \texttt{CodeFormat} type also includes a method \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html\#FormatHtml}{CodeFormat.FormatHtml} that can be used +to generate nice HTML output from an F\# snippet. This is used, for example, on +\href{http://www.fssnip.net}{F\# Snippets}. The following example shows how to call it: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{prefix} \ops{=} \str{"fst"} +\kwd{let} \id{html} \ops{=} \ltyp{CodeFormat}{.}\id{FormatHtml}{(}\id{snippets}{,} \id{prefix}{)} + +\com{// Print all snippets, in case there is more of them} +\kwd{for} \lfun{snip} \kwd{in} \id{html}{.}\id{Snippets} \kwd{do} + \lfun{printfn} \str{"}\lprf{\%s}\str{"} \lfun{snip}{.}\id{Content} + +\com{// Print HTML code that is generated for ToolTips} +\lfun{printfn} \str{"}\lprf{\%s}\str{"} \id{html}{.}\id{ToolTip} + +\end{lstlisting} + + + +If the input contains multiple snippets separated using the \texttt{//[snippet:...]} comment, e.g.: + + + +
      +1: 
+2: 
+3: 
+4: 
+5: 
+6: 
+7: 
+
      +
      // [snippet: First sample]
+printf "The answer is: %A" 42
+// [/snippet]
+// [snippet: Second sample]
+printf "Hello world!"
+// [/snippet]
+
      +
      + + +then the formatter returns multiple HTML blocks. However, the generated tooltips +are shared by all snippets (to save space) and so they are returned separately. + + +\end{document} \ No newline at end of file diff --git a/commandline.fsx b/commandline.fsx new file mode 100644 index 000000000..aa6e2b80c --- /dev/null +++ b/commandline.fsx @@ -0,0 +1,112 @@ +(** +# Command line + +To use F# Formatting tools via the command line, you can use the `fsdocs` dotnet tool. + + [lang=text] + dotnet tool install fsdocs-tool + dotnet fsdocs [command] [options] + +## The build command + +This command processes a `docs` directory and generates API docs for projects in the solution according to the +rules of [API doc generation](apidocs.html). The input accepted is described in [content](content.html). + + [lang=text] + fsdocs build + +The command line options accepted are: + +Command Line Option | Description +:--- | :--- +`--input` | Input directory of content (default: `docs`) +`--projects` | Project files to build API docs for outputs, defaults to all packable projects +`--output` | Output Directory (default 'output' for 'build' and 'tmp/watch' for 'watch') +`--noapidocs` | Disable generation of API docs +`--ignoreprojects` | Disable project cracking +`--eval` | Evaluate F# fragments in scripts +`--saveimages` | Save images referenced in docs +`--nolinenumbers` | Don't add line numbers, the default is to add line numbers. +`--parameters` | Additional substitution parameters for templates +`--nonpublic` | The tool will also generate documentation for non-public members +`--nodefaultcontent` | Do not copy default content styles, javascript or use default templates +`--clean` | Clean the output directory +`--help` | Display this help screen +`--version` | Display version information +`--properties` | Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4 +`--fscoptions` | Additional arguments passed down as `otherflags` to the F# compiler when the API is being generated.
      Note that these arguments are trimmed, this is to overcome [a limitation in the command line argument processing](https://github.com/commandlineparser/commandline/issues/58).
      A typical use-case would be to pass an addition assembly reference.
      Example `--fscoptions " -r:MyAssembly.dll"` +`--strict` | Fail if docs are missing or can't be generated + + +The following command line options are also accepted but it is instead recommended you use +settings in your .fsproj project files: + +Command Line Option | Description +:--- | :--- +`--sourcefolder` | Source folder at time of component build (``) +`--sourcerepo` | Source repository for github links (``) +`--mdcomments` | Assume comments in F# code are markdown (``) + + +The command will report on any `.fsproj` files that it finds, telling you if it decides to skip a particular file and why. + +For example, a project will be skipped if: + +* The project name contains ".Tests" or "test" (because it looks like a test project) + + +* The project does not contain + + + ``` + true + ``` + + +## The watch command + +This command does the same as `fsdocs build` but in "watch" mode, waiting for changes. Only the files in the input +directory (e.g. `docs`) are watched. A browser will be launched automatically (unless `--nolaunch` is specified). + +You will need to ensure that the input directory exists, and contains at least `index.md`, otherwise the browser will +report an error (e.g. "Problem loading...", "Connection was reset"). + + [lang=text] + fsdocs watch + +Restarting may be necesssary on changes to project files. The same parameters are accepted, plus these: + +Command Line Option | Description +:--- | :--- +`--noserver` | Do not serve content when watching. +`--nolaunch` | Do not launch a browser window. +`--open` | URL extension to launch [http://localhost:/%s.](http://localhost:/%s.) +`--port` | Port to serve content for [http://localhost](http://localhost) serving. + + +## Searchable docs + +When using the command-line tool a [Fuse](https://www.fusejs.io/) search index is automatically generated in `index.json`. +A search box is included in the default template via an [HTML Dialog element](https://developer.mozilla.org/docs/Web/HTML/Element/dialog). +To add search to your own `_template.html`: + +* include an HTML element with id `search-btn` + +* include a `dialog` element + +* include `fsdocs-search.js` script + +```html + + + +
      +
        +

        Type something to start searching.

        +
        +         + +``` + +*) + diff --git a/commandline.html b/commandline.html new file mode 100644 index 000000000..675d7c859 --- /dev/null +++ b/commandline.html @@ -0,0 +1,518 @@ + + + + + + + + + + + + + + + + + + Command line + | FSharp.Formatting + + + + + + + + + + + + + +
        +
        + + + Header menu logo + FSharp.Formatting + +
        +
        + + + + + +
        +
        + +
        +
        + +

        Command line

        +

        To use F# Formatting tools via the command line, you can use the fsdocs dotnet tool.

        +
        dotnet tool install fsdocs-tool
+dotnet fsdocs [command] [options]
+
        +

        The build command

        +

        This command processes a docs directory and generates API docs for projects in the solution according to the +rules of API doc generation. The input accepted is described in content.

        +
        fsdocs build
+
        +

        The command line options accepted are:

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

        Command Line Option

        Description

        --input

        Input directory of content (default: docs)

        --projects

        Project files to build API docs for outputs, defaults to all packable projects

        --output

        Output Directory (default 'output' for 'build' and 'tmp/watch' for 'watch')

        --noapidocs

        Disable generation of API docs

        --ignoreprojects

        Disable project cracking

        --eval

        Evaluate F# fragments in scripts

        --saveimages

        Save images referenced in docs

        --nolinenumbers

        Don't add line numbers, the default is to add line numbers.

        --parameters

        Additional substitution parameters for templates

        --nonpublic

        The tool will also generate documentation for non-public members

        --nodefaultcontent

        Do not copy default content styles, javascript or use default templates

        --clean

        Clean the output directory

        --help

        Display this help screen

        --version

        Display version information

        --properties

        Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4

        --fscoptions

        Additional arguments passed down as otherflags to the F# compiler when the API is being generated.
        Note that these arguments are trimmed, this is to overcome a limitation in the command line argument processing.
        A typical use-case would be to pass an addition assembly reference.
        Example --fscoptions " -r:MyAssembly.dll"

        --strict

        Fail if docs are missing or can't be generated

        + +

        The following command line options are also accepted but it is instead recommended you use +settings in your .fsproj project files:

        + + + + + + + + + + + + + + + + + + + + + +

        Command Line Option

        Description

        --sourcefolder

        Source folder at time of component build (<FsDocsSourceFolder>)

        --sourcerepo

        Source repository for github links (<FsDocsSourceRepository>)

        --mdcomments

        Assume comments in F# code are markdown (<UsesMarkdownComments>)

        + +

        The command will report on any .fsproj files that it finds, telling you if it decides to skip a particular file and why.

        +

        For example, a project will be skipped if:

        +
          +
        • The project name contains ".Tests" or "test" (because it looks like a test project)
          • +
        • +

          The project does not contain

          +
          <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
          +
          • +
        +

        The watch command

        +

        This command does the same as fsdocs build but in "watch" mode, waiting for changes. Only the files in the input +directory (e.g. docs) are watched. A browser will be launched automatically (unless --nolaunch is specified).

        +

        You will need to ensure that the input directory exists, and contains at least index.md, otherwise the browser will +report an error (e.g. "Problem loading...", "Connection was reset").

        +
        fsdocs watch
+
        +

        Restarting may be necesssary on changes to project files. The same parameters are accepted, plus these:

        + + + + + + + + + + + + + + + + + + + + + + + + + +

        Command Line Option

        Description

        --noserver

        Do not serve content when watching.

        --nolaunch

        Do not launch a browser window.

        --open

        URL extension to launch http://localhost:/%s.

        --port

        Port to serve content for http://localhost serving.

        + +

        Searchable docs

        +

        When using the command-line tool a Fuse search index is automatically generated in index.json. +A search box is included in the default template via an HTML Dialog element.
        +To add search to your own _template.html:

        +
          +
        • include an HTML element with id search-btn
          • +
        • include a dialog element
          • +
        • include fsdocs-search.js script
          • +
        +
        <button id="search-btn">Open search dialog</button>
+<dialog>
+    <input type="search" placeholder="Search docs" />
+    <div class="results">
+        <ul></ul>
+        <p class="empty">Type something to start searching.</p>
+    </div>
+</dialog>
+<script type="module" src="{`{root}}content/fsdocs-search.js"></script>
+
        + + +
        +
        + + + +
        +
          +

          Type something to start searching.

          +
          +           + + + + + + + + \ No newline at end of file diff --git a/commandline.ipynb b/commandline.ipynb new file mode 100644 index 000000000..a6e1e655c --- /dev/null +++ b/commandline.ipynb @@ -0,0 +1,149 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "# Command line\n", + "\n", + "To use F# Formatting tools via the command line, you can use the `fsdocs` dotnet tool.\n", + "\n", + " [lang=text]\n", + " dotnet tool install fsdocs-tool\n", + " dotnet fsdocs [command] [options]\n", + "\n", + "## The build command\n", + "\n", + "This command processes a `docs` directory and generates API docs for projects in the solution according to the\n", + "rules of [API doc generation](apidocs.html). The input accepted is described in [content](content.html).\n", + "\n", + " [lang=text]\n", + " fsdocs build\n", + "\n", + "The command line options accepted are:\n", + "\n", + "Command Line Option | Description\n", + ":--- | :---\n", + "`--input` | Input directory of content (default: `docs`)\n", + "`--projects` | Project files to build API docs for outputs, defaults to all packable projects\n", + "`--output` | Output Directory (default \u0027output\u0027 for \u0027build\u0027 and \u0027tmp/watch\u0027 for \u0027watch\u0027)\n", + "`--noapidocs` | Disable generation of API docs\n", + "`--ignoreprojects` | Disable project cracking\n", + "`--eval` | Evaluate F# fragments in scripts\n", + "`--saveimages` | Save images referenced in docs\n", + "`--nolinenumbers` | Don\u0027t add line numbers, the default is to add line numbers.\n", + "`--parameters` | Additional substitution parameters for templates\n", + "`--nonpublic` | The tool will also generate documentation for non-public members\n", + "`--nodefaultcontent` | Do not copy default content styles, javascript or use default templates\n", + "`--clean` | Clean the output directory\n", + "`--help` | Display this help screen\n", + "`--version` | Display version information\n", + "`--properties` | Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4\n", + "`--fscoptions` | Additional arguments passed down as `otherflags` to the F# compiler when the API is being generated.\u003cbr/\u003eNote that these arguments are trimmed, this is to overcome [a limitation in the command line argument processing](https://github.com/commandlineparser/commandline/issues/58).\u003cbr/\u003eA typical use-case would be to pass an addition assembly reference.\u003cbr/\u003eExample `--fscoptions \" -r:MyAssembly.dll\"`\n", + "`--strict` | Fail if docs are missing or can\u0027t be generated\n", + "\n", + "\n", + "The following command line options are also accepted but it is instead recommended you use\n", + "settings in your .fsproj project files:\n", + "\n", + "Command Line Option | Description\n", + ":--- | :---\n", + "`--sourcefolder` | Source folder at time of component build (`\u003cFsDocsSourceFolder\u003e`)\n", + "`--sourcerepo` | Source repository for github links (`\u003cFsDocsSourceRepository\u003e`)\n", + "`--mdcomments` | Assume comments in F# code are markdown (`\u003cUsesMarkdownComments\u003e`)\n", + "\n", + "\n", + "The command will report on any `.fsproj` files that it finds, telling you if it decides to skip a particular file and why.\n", + "\n", + "For example, a project will be skipped if:\n", + "\n", + "* The project name contains \".Tests\" or \"test\" (because it looks like a test project)\n", + " \n", + "\n", + "* The project does not contain\n", + " \n", + "\n", + " ```\n", + " \u003cGenerateDocumentationFile\u003etrue\u003c/GenerateDocumentationFile\u003e\n", + " ```\n", + " \n", + "\n", + "## The watch command\n", + "\n", + "This command does the same as `fsdocs build` but in \"watch\" mode, waiting for changes. Only the files in the input\n", + "directory (e.g. `docs`) are watched. A browser will be launched automatically (unless `--nolaunch` is specified).\n", + "\n", + "You will need to ensure that the input directory exists, and contains at least `index.md`, otherwise the browser will\n", + "report an error (e.g. \"Problem loading...\", \"Connection was reset\").\n", + "\n", + " [lang=text]\n", + " fsdocs watch\n", + "\n", + "Restarting may be necesssary on changes to project files. The same parameters are accepted, plus these:\n", + "\n", + "Command Line Option | Description\n", + ":--- | :---\n", + "`--noserver` | Do not serve content when watching.\n", + "`--nolaunch` | Do not launch a browser window.\n", + "`--open` | URL extension to launch [http://localhost:\u003cport\u003e/%s.](http://localhost:\u003cport\u003e/%s.)\n", + "`--port` | Port to serve content for [http://localhost](http://localhost) serving.\n", + "\n", + "\n", + "## Searchable docs\n", + "\n", + "When using the command-line tool a [Fuse](https://www.fusejs.io/) search index is automatically generated in `index.json`.\n", + "A search box is included in the default template via an [HTML Dialog element](https://developer.mozilla.org/docs/Web/HTML/Element/dialog).\n", + "To add search to your own `_template.html`:\n", + "\n", + "* include an HTML element with id `search-btn`\n", + "\n", + "* include a `dialog` element\n", + "\n", + "* include `fsdocs-search.js` script\n", + "\n", + "```html\n", + "\u003cbutton id=\"search-btn\"\u003eOpen search dialog\u003c/button\u003e\n", + "\u003cdialog\u003e\n", + " \u003cinput type=\"search\" placeholder=\"Search docs\" /\u003e\n", + " \u003cdiv class=\"results\"\u003e\n", + " \u003cul\u003e\u003c/ul\u003e\n", + " \u003cp class=\"empty\"\u003eType something to start searching.\u003c/p\u003e\n", + " \u003c/div\u003e\n", + "\u003c/dialog\u003e\n", + "\u003cscript type=\"module\" src=\"{`{root}}content/fsdocs-search.js\"\u003e\u003c/script\u003e\n", + "```\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/commandline.md b/commandline.md new file mode 100644 index 000000000..a44e5d57d --- /dev/null +++ b/commandline.md @@ -0,0 +1,110 @@ +# Command line + +To use F# Formatting tools via the command line, you can use the `fsdocs` dotnet tool. + + [lang=text] + dotnet tool install fsdocs-tool + dotnet fsdocs [command] [options] + +## The build command + +This command processes a `docs` directory and generates API docs for projects in the solution according to the +rules of [API doc generation](apidocs.html). The input accepted is described in [content](content.html). + + [lang=text] + fsdocs build + +The command line options accepted are: + +Command Line Option | Description +:--- | :--- +`--input` | Input directory of content (default: `docs`) +`--projects` | Project files to build API docs for outputs, defaults to all packable projects +`--output` | Output Directory (default 'output' for 'build' and 'tmp/watch' for 'watch') +`--noapidocs` | Disable generation of API docs +`--ignoreprojects` | Disable project cracking +`--eval` | Evaluate F# fragments in scripts +`--saveimages` | Save images referenced in docs +`--nolinenumbers` | Don't add line numbers, the default is to add line numbers. +`--parameters` | Additional substitution parameters for templates +`--nonpublic` | The tool will also generate documentation for non-public members +`--nodefaultcontent` | Do not copy default content styles, javascript or use default templates +`--clean` | Clean the output directory +`--help` | Display this help screen +`--version` | Display version information +`--properties` | Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4 +`--fscoptions` | Additional arguments passed down as `otherflags` to the F# compiler when the API is being generated.
          Note that these arguments are trimmed, this is to overcome [a limitation in the command line argument processing](https://github.com/commandlineparser/commandline/issues/58).
          A typical use-case would be to pass an addition assembly reference.
          Example `--fscoptions " -r:MyAssembly.dll"` +`--strict` | Fail if docs are missing or can't be generated + + +The following command line options are also accepted but it is instead recommended you use +settings in your .fsproj project files: + +Command Line Option | Description +:--- | :--- +`--sourcefolder` | Source folder at time of component build (``) +`--sourcerepo` | Source repository for github links (``) +`--mdcomments` | Assume comments in F# code are markdown (``) + + +The command will report on any `.fsproj` files that it finds, telling you if it decides to skip a particular file and why. + +For example, a project will be skipped if: + +* The project name contains ".Tests" or "test" (because it looks like a test project) + + +* The project does not contain + + + ``` + true + ``` + + +## The watch command + +This command does the same as `fsdocs build` but in "watch" mode, waiting for changes. Only the files in the input +directory (e.g. `docs`) are watched. A browser will be launched automatically (unless `--nolaunch` is specified). + +You will need to ensure that the input directory exists, and contains at least `index.md`, otherwise the browser will +report an error (e.g. "Problem loading...", "Connection was reset"). + + [lang=text] + fsdocs watch + +Restarting may be necesssary on changes to project files. The same parameters are accepted, plus these: + +Command Line Option | Description +:--- | :--- +`--noserver` | Do not serve content when watching. +`--nolaunch` | Do not launch a browser window. +`--open` | URL extension to launch [http://localhost:/%s.](http://localhost:/%s.) +`--port` | Port to serve content for [http://localhost](http://localhost) serving. + + +## Searchable docs + +When using the command-line tool a [Fuse](https://www.fusejs.io/) search index is automatically generated in `index.json`. +A search box is included in the default template via an [HTML Dialog element](https://developer.mozilla.org/docs/Web/HTML/Element/dialog). +To add search to your own `_template.html`: + +* include an HTML element with id `search-btn` + +* include a `dialog` element + +* include `fsdocs-search.js` script + +```html + + + +
          +
            +

            Type something to start searching.

            +
            +             + +``` + + diff --git a/commandline.tex b/commandline.tex new file mode 100644 index 000000000..2aff30cb7 --- /dev/null +++ b/commandline.tex @@ -0,0 +1,183 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + +\section*{Command line} + + + +To use F\# Formatting tools via the command line, you can use the \texttt{fsdocs} dotnet tool. +\begin{lstlisting} +dotnet tool install fsdocs-tool +dotnet fsdocs [command] [options] + +\end{lstlisting} +\subsection*{The build command} + + + +This command processes a \texttt{docs} directory and generates API docs for projects in the solution according to the +rules of \href{apidocs.html}{API doc generation}. The input accepted is described in \href{content.html}{content}. +\begin{lstlisting} +fsdocs build + +\end{lstlisting} + + +The command line options accepted are: +\begin{tabular}{|l|l|}\hline +\textbf{Command Line Option} & \textbf{Description}\\ \hline\hline +\texttt{--input} & Input directory of content (default: \texttt{docs})\\ \hline +\texttt{--projects} & Project files to build API docs for outputs, defaults to all packable projects\\ \hline +\texttt{--output} & Output Directory (default 'output' for 'build' and 'tmp/watch' for 'watch')\\ \hline +\texttt{--noapidocs} & Disable generation of API docs\\ \hline +\texttt{--ignoreprojects} & Disable project cracking\\ \hline +\texttt{--eval} & Evaluate F\# fragments in scripts\\ \hline +\texttt{--saveimages} & Save images referenced in docs\\ \hline +\texttt{--nolinenumbers} & Don't add line numbers, the default is to add line numbers.\\ \hline +\texttt{--parameters} & Additional substitution parameters for templates\\ \hline +\texttt{--nonpublic} & The tool will also generate documentation for non-public members\\ \hline +\texttt{--nodefaultcontent} & Do not copy default content styles, javascript or use default templates\\ \hline +\texttt{--clean} & Clean the output directory\\ \hline +\texttt{--help} & Display this help screen\\ \hline +\texttt{--version} & Display version information\\ \hline +\texttt{--properties} & Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4\\ \hline +\texttt{--fscoptions} & Additional arguments passed down as \texttt{otherflags} to the F\# compiler when the API is being generated.
            Note that these arguments are trimmed, this is to overcome \href{https://github.com/commandlineparser/commandline/issues/58}{a limitation in the command line argument processing}.
            A typical use-case would be to pass an addition assembly reference.
            Example \texttt{--fscoptions " -r:MyAssembly.dll"}\\ \hline +\texttt{--strict} & Fail if docs are missing or can't be generated\\ \hline +\end{tabular} + + + +The following command line options are also accepted but it is instead recommended you use +settings in your .fsproj project files: +\begin{tabular}{|l|l|}\hline +\textbf{Command Line Option} & \textbf{Description}\\ \hline\hline +\texttt{--sourcefolder} & Source folder at time of component build (\texttt{})\\ \hline +\texttt{--sourcerepo} & Source repository for github links (\texttt{})\\ \hline +\texttt{--mdcomments} & Assume comments in F\# code are markdown (\texttt{})\\ \hline +\end{tabular} + + + +The command will report on any \texttt{.fsproj} files that it finds, telling you if it decides to skip a particular file and why. + + +For example, a project will be skipped if: +\begin{itemize} +\item + +The project name contains ".Tests" or "test" (because it looks like a test project) + +\item + +The project does not contain +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +{<}\id{GenerateDocumentationFile}{>}\kwd{true}\ops{} + + +\end{lstlisting} + + +\end{itemize} + +\subsection*{The watch command} + + + +This command does the same as \texttt{fsdocs build} but in "watch" mode, waiting for changes. Only the files in the input +directory (e.g. \texttt{docs}) are watched. A browser will be launched automatically (unless \texttt{--nolaunch} is specified). + + +You will need to ensure that the input directory exists, and contains at least \texttt{index.md}, otherwise the browser will +report an error (e.g. "Problem loading...", "Connection was reset"). +\begin{lstlisting} +fsdocs watch + +\end{lstlisting} + + +Restarting may be necesssary on changes to project files. The same parameters are accepted, plus these: +\begin{tabular}{|l|l|}\hline +\textbf{Command Line Option} & \textbf{Description}\\ \hline\hline +\texttt{--noserver} & Do not serve content when watching.\\ \hline +\texttt{--nolaunch} & Do not launch a browser window.\\ \hline +\texttt{--open} & URL extension to launch \href{http://localhost:/\%s.}{http://localhost:/\%s.}\\ \hline +\texttt{--port} & Port to serve content for \href{http://localhost}{http://localhost} serving.\\ \hline +\end{tabular} + +\subsection*{Searchable docs} + + + +When using the command-line tool a \href{https://www.fusejs.io/}{Fuse} search index is automatically generated in \texttt{index.json}. +A search box is included in the default template via an \href{https://developer.mozilla.org/docs/Web/HTML/Element/dialog}{HTML Dialog element}. + +To add search to your own \texttt{\_template.html}: +\begin{itemize} +\item include an HTML element with id \texttt{search-btn} + +\item include a \texttt{dialog} element + +\item include \texttt{fsdocs-search.js} script + +\end{itemize} + +\begin{lstlisting} + + + +
            +
              +

              Type something to start searching.

              +
              +               + + +\end{lstlisting} + + +\end{document} \ No newline at end of file diff --git a/content.fsx b/content.fsx new file mode 100644 index 000000000..0e4a82eef --- /dev/null +++ b/content.fsx @@ -0,0 +1,232 @@ +(** + +*) +#r "nuget: FSharp.Formatting,1.0.0" +(** +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=content.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//content.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//content.ipynb) + +# Creating Content + +The ["fsdocs" tool](commandline.html) allows documentation for a site to be built +from content in a `docs` directory. The expected structure for a `docs` directory is + + [lang=text] + docs/**/*.md -- markdown with embedded code, converted to html and optionally tex/ipynb + docs/**/*.fsx -- fsx scripts converted to html and optionally tex/ipynb + docs/**/* -- other content, copied over + docs/**/_template.html -- optional template, specifies the HTML template for this directory and its contents + docs/**/_template.tex -- optionally indicates Latex files should be generated + docs/**/_template.ipynb -- optionally indicates F# ipynb files should be generated + docs/**/_template.fsx -- optionally indicates F# fsx files should be generated (even from markdown) + docs/reference/_template.html -- optionally specifies the default template for reference docs + +Processing is by these two commands: + + dotnet fsdocs build + dotnet fsdocs watch + +The output goes in `output/` by default. Processing is recursive, making this a form of static site generation. + +## Literate Scripts and Markdown Content + +The input directory may contain [literate scripts](literate.html) and markdown content. + +## Other Content + +Content that is not `*.fsx` or `*.md` is copied across. + +## Default Styling Content + +By default additional content such as `fsdocs-search.js`, `fsdocs-tips.js` and `fsdocs-default.css` are included in +the `content` directory of the output. This can be suppressed with `--nodefaultcontent` or by having your own +copy of this content in your `content` directory. + +## Ignored Content + +Any file or directory beginning with `.` is ignored. + +## Front matter + +Each content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags. + +For markdown, the format is: + +``` +--- +title: Some Title +category: Some Category +categoryindex: 2 +index: 3 +description: Some description +keywords: tag1, tag2, tag3 +--- +``` +For F# scripts the frontmatter is in this form: + + (** + --- + title: A Literate Script + category: Examples + categoryindex: 2 + index: 1 + description: Some description + keywords: tag1, tag2, tag3 + --- + *) + +All entries are optional. +The `categoryindex` determines the ordering of categories. +The `index` determines the ordering of within each category. +The `title` is used in the navigation bar instead of any title inferred from the document. +The `description` is used in `` else `/` followed by `fsdocs-collection-name` +`fsdocs-collection-name` | Name of .sln, single .fsproj or containing directory +`fsdocs-content` | Main page content +`fsdocs-list-of-namespaces` | HTML `
            • ` list of namespaces with links +`fsdocs-list-of-documents` | HTML `
            • ` list of documents with titles and links +`fsdocs-page-title` | First h1 heading in literate file. Generated for API docs +`fsdocs-source` | Original literate script or markdown source +`fsdocs-source-filename` | Name of original input source, relative to the `docs` root +`fsdocs-source-basename` | Name of original input source, excluding its extensions, relative to the `docs` root +`fsdocs-tooltips` | Generated hidden div elements for tooltips +`fsdocs-watch-script` | The websocket script used in watch mode to trigger hot reload +`fsdocs-previous-page-link` | A relative link to the previous page based on the frontmatter index data +`fsdocs-next-page-link` | A relative link to the next page based on the frontmatter index data +`fsdocs-head-extra` | Additional html content loaded from the `_head.html` file if present in the `--input` folder +`fsdocs-body-extra` | Additional html content loaded from the `_body.html` file if present in the `--input` folder +`fsdocs-body-class` | A css class value to help distinguish between `content` and `api-docs` +`fsdocs-meta-tags` | A set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter + + +The following substitutions are extracted from your project files and may or may not be used by the default +template: + +Substitution name | Value +:--- | :--- +`fsdocs-copyright` | `` +`fsdocs-package-project-url` | `` +`fsdocs-package-license-expression` | `` +`fsdocs-package-tags` | `` +`fsdocs-package-version` | `` + + +For the `fsdocs` tool, additional substitutions can be specified using `--parameters`. + +## Cross References to API Docs + +Markdown content can contain cross-references to API Docs. Use inline +markdown code snippets of the special form ``cref:T:MyNamespace.MyType`` where `T:MyNamespace.MyType` +is a method, property or type xml doc sig reference, see [API Docs](apidocs.html). +This can include any cross-references resolved by fsdocs. + +The generated API documentation includes buttons to copy the XML and Markdown forms of API doc references. + +For example, within this project, + +* the text ``cref:T:FSharp.Formatting.Markdown.MarkdownParagraph`` resolves to the link [MarkdownParagraph](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html) + + +* the text ``cref:T:System.Console`` resolves to the link [Console](https://learn.microsoft.com/dotnet/api/system.console) + + +* the text ``cref:M:System.Console.WriteLine`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline) + + +* the text ``cref:M:System.Console.WriteLine(System.String)`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline) + + +* the text ```cref:T:FSharp.Control.FSharpAsync`1``` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync-1) + + +* the text ``cref:T:FSharp.Control.FSharpAsync`` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync) + + +* the text ```cref:T:FSharp.Core.array`1``` resolves to the link [array](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-array-1) + + +* the text ``cref:T:FSharp.Core.OptionModule`` resolves to the link [Option](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-optionmodule) + + +* the text ````cref:M:FSharp.Collections.ListModule.Append``1```` resolves to the link [ListModule.Append](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule#Append) + + +> NOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the +external link. [Please report it](https://github.com/fsprojects/FSharp.Formatting/issues/new). +> + +Determining xmldoc sig references is not simple. The API doc generated pages come with +buttons to copy out the XmlDoc signature. + +## Generating HTML Output + +HTML is generated by default. You can also add a `_template.html`. This should contain `{{fsdocs-content}}`, `{{fsdocs-tooltips}}` +and other placeholders. Substitutions are +applied to this template. +If a file `_template.html` exists, then it's used as the template for HTML generation for that directory and all sub-content. + +## Generating LaTeX output + +To generate .tex output for each script and markdown file, add a `_template.tex`. Substitutions are +applied to this template. The file is either empty or contains `{{fsdocs-content}}` as the key where the body +of the document is placed. + +## Generating iPython Notebook output + +To generate .ipynb output for each script and markdown file, add a `_template.ipynb`, usually empty. Substitutions are +applied to this template. + +To add a `mybinder` badge to your generated notebook, ensure you have a `Dockerfile` and `NuGet.config` +in your `docs` directory and use text like this: + + [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb) + +## Generating Script outputs + +To generate .fsx output for each script and markdown file, add a `_template.fsx`, usually empty. Substitutions are +applied to this template. It is either empty or contains `{{fsdocs-content}}` as the key where the body +of the script is placed. + +*) + diff --git a/content.html b/content.html new file mode 100644 index 000000000..5afff334e --- /dev/null +++ b/content.html @@ -0,0 +1,632 @@ + + + + + + + + + + + + + + + + + + Creating Content + | FSharp.Formatting + + + + + + + + + + + + + +
              +
              + + + Header menu logo + FSharp.Formatting + +
              +
              + + + + + +
              +
              + +
              +
              + +

              Binder  +Script  +Notebook

              +

              Creating Content

              +

              The "fsdocs" tool allows documentation for a site to be built +from content in a docs directory. The expected structure for a docs directory is

              +
              docs/**/*.md                  -- markdown with embedded code, converted to html and optionally tex/ipynb
+docs/**/*.fsx                 -- fsx scripts converted to html and optionally tex/ipynb
+docs/**/*                     -- other content, copied over
+docs/**/_template.html        -- optional template, specifies the HTML template for this directory and its contents
+docs/**/_template.tex         -- optionally indicates Latex files should be generated
+docs/**/_template.ipynb       -- optionally indicates F# ipynb files should be generated
+docs/**/_template.fsx         -- optionally indicates F# fsx files should be generated (even from markdown)
+docs/reference/_template.html -- optionally specifies the default template for reference docs
+
              +

              Processing is by these two commands:

              +
              dotnet fsdocs build
+dotnet fsdocs watch
+
              +

              The output goes in output/ by default. Processing is recursive, making this a form of static site generation.

              +

              Literate Scripts and Markdown Content

              +

              The input directory may contain literate scripts and markdown content.

              +

              Other Content

              +

              Content that is not *.fsx or *.md is copied across.

              +

              Default Styling Content

              +

              By default additional content such as fsdocs-search.js, fsdocs-tips.js and fsdocs-default.css are included in +the content directory of the output. This can be suppressed with --nodefaultcontent or by having your own +copy of this content in your content directory.

              +

              Ignored Content

              +

              Any file or directory beginning with . is ignored.

              +

              Front matter

              +

              Each content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags.

              +

              For markdown, the format is:

              +
              ---
+title: Some Title
+category: Some Category
+categoryindex: 2
+index: 3
+description: Some description
+keywords: tag1, tag2, tag3
+---
+
              +

              For F# scripts the frontmatter is in this form:

              +
              (**
+---
+title: A Literate Script
+category: Examples
+categoryindex: 2
+index: 1
+description: Some description
+keywords: tag1, tag2, tag3
+---
+*)
+
              +

              All entries are optional. +The categoryindex determines the ordering of categories. +The index determines the ordering of within each category. +The title is used in the navigation bar instead of any title inferred from the document. +The description is used in <meta name="description" as part of the {{fsdocs-meta-tags}} substitution. +The keywords are also used in a meta tag as part of {{fsdocs-meta-tags}}. Separate them using a ,.

              +

              Link Translation for Inputs

              +

              If an input is used in markdown as a target of a markdown direct link, then that is replaced by the output file. For example:

              +
              [Some Text](some-file.md)
+
              +

              becomes

              +
              [Some Text](some-file.html)
+
              +

              if some-file.md is one of the inputs.

              +

              Multi-language Content

              +

              Versions of content in other languages should go in two-letter coded sub-directories, e.g.

              +
              docs/ja/...
+docs/de/...
+
              +

              These will be elided from the main table-of-contents and search indexes. (Currently no language-specific +table of contents is built, nor language-specific site search indexes).

              +

              Templates and Substitutions

              +

              Templates are used for HTML (_template.html), LaTeX (_template.tex), Notebooks (_template.ipynb) +and F# script outputs (_template.fsx).

              +

              The following substitutions determine the primary (non-styling) content of your site. +For example {{fsdocs-content}} is replaced with the generated content in each file.

              +

              Substitutions are applied when generating content from HTML templates, IPYNB templates, FSX templates. +They are also applied to content apart from Markdown inline code `...`, Markdown LaTeX and +generated outputs.

              +

              See Styling for information about template parameters and styling beyond the default template.

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

              Substitution name

              Generated content

              root

              <PackageProjectUrl> else / followed by fsdocs-collection-name

              fsdocs-collection-name

              Name of .sln, single .fsproj or containing directory

              fsdocs-content

              Main page content

              fsdocs-list-of-namespaces

              HTML <li> list of namespaces with links

              fsdocs-list-of-documents

              HTML <li> list of documents with titles and links

              fsdocs-page-title

              First h1 heading in literate file. Generated for API docs

              fsdocs-source

              Original literate script or markdown source

              fsdocs-source-filename

              Name of original input source, relative to the docs root

              fsdocs-source-basename

              Name of original input source, excluding its extensions, relative to the docs root

              fsdocs-tooltips

              Generated hidden div elements for tooltips

              fsdocs-watch-script

              The websocket script used in watch mode to trigger hot reload

              fsdocs-previous-page-link

              A relative link to the previous page based on the frontmatter index data

              fsdocs-next-page-link

              A relative link to the next page based on the frontmatter index data

              fsdocs-head-extra

              Additional html content loaded from the _head.html file if present in the --input folder

              fsdocs-body-extra

              Additional html content loaded from the _body.html file if present in the --input folder

              fsdocs-body-class

              A css class value to help distinguish between content and api-docs

              fsdocs-meta-tags

              A set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter

              + +

              The following substitutions are extracted from your project files and may or may not be used by the default +template:

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

              Substitution name

              Value

              fsdocs-copyright

              <Copyright>

              fsdocs-package-project-url

              <PackageProjectUrl>

              fsdocs-package-license-expression

              <PackageLicenseExpression>

              fsdocs-package-tags

              <PackageTags>

              fsdocs-package-version

              <Version>

              + +

              For the fsdocs tool, additional substitutions can be specified using --parameters.

              +

              Cross References to API Docs

              +

              Markdown content can contain cross-references to API Docs. Use inline +markdown code snippets of the special form `cref:T:MyNamespace.MyType` where T:MyNamespace.MyType +is a method, property or type xml doc sig reference, see API Docs. +This can include any cross-references resolved by fsdocs.

              +

              The generated API documentation includes buttons to copy the XML and Markdown forms of API doc references.

              +

              For example, within this project,

              +
                +

              • the text `cref:T:FSharp.Formatting.Markdown.MarkdownParagraph` resolves to the link MarkdownParagraph

                • +

              • the text `cref:T:System.Console` resolves to the link Console

                • +

              • the text `cref:M:System.Console.WriteLine` resolves to the link Console.WriteLine

                • +

              • the text `cref:M:System.Console.WriteLine(System.String)` resolves to the link Console.WriteLine

                • +

              • the text ``cref:T:FSharp.Control.FSharpAsync`1`` resolves to the link Async

                • +

              • the text `cref:T:FSharp.Control.FSharpAsync` resolves to the link Async

                • +

              • the text ``cref:T:FSharp.Core.array`1`` resolves to the link array

                • +

              • the text `cref:T:FSharp.Core.OptionModule` resolves to the link Option

                • +

              • the text ```cref:M:FSharp.Collections.ListModule.Append``1``` resolves to the link ListModule.Append

                • +
              +
              +

              NOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the +external link. Please report it.

              +
              +

              Determining xmldoc sig references is not simple. The API doc generated pages come with +buttons to copy out the XmlDoc signature.

              +

              Generating HTML Output

              +

              HTML is generated by default. You can also add a _template.html. This should contain {{fsdocs-content}}, {{fsdocs-tooltips}} +and other placeholders. Substitutions are +applied to this template. +If a file _template.html exists, then it's used as the template for HTML generation for that directory and all sub-content.

              +

              Generating LaTeX output

              +

              To generate .tex output for each script and markdown file, add a _template.tex. Substitutions are +applied to this template. The file is either empty or contains {{fsdocs-content}} as the key where the body +of the document is placed.

              +

              Generating iPython Notebook output

              +

              To generate .ipynb output for each script and markdown file, add a _template.ipynb, usually empty. Substitutions are +applied to this template.

              +

              To add a mybinder badge to your generated notebook, ensure you have a Dockerfile and NuGet.config +in your docs directory and use text like this:

              +
              [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)
+
              +

              Generating Script outputs

              +

              To generate .fsx output for each script and markdown file, add a _template.fsx, usually empty. Substitutions are +applied to this template. It is either empty or contains {{fsdocs-content}} as the key where the body +of the script is placed.

              + +
              union case Option.Some: Value: 'T -> Option<'T>
              +
              namespace Microsoft.FSharp.Text
              + +
              +
              + + + +
              +
                +

                Type something to start searching.

                +
                +                 + + + + + + + + \ No newline at end of file diff --git a/content.ipynb b/content.ipynb new file mode 100644 index 000000000..505baa3d1 --- /dev/null +++ b/content.ipynb @@ -0,0 +1,290 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "#r \"nuget: FSharp.Formatting,1.0.0\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=content.ipynb)\u0026emsp;\n", + "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//content.fsx)\u0026emsp;\n", + "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//content.ipynb)\n", + "\n", + "# Creating Content\n", + "\n", + "The [\"fsdocs\" tool](commandline.html) allows documentation for a site to be built\n", + "from content in a `docs` directory. The expected structure for a `docs` directory is\n", + "\n", + " [lang=text]\n", + " docs/**/*.md -- markdown with embedded code, converted to html and optionally tex/ipynb\n", + " docs/**/*.fsx -- fsx scripts converted to html and optionally tex/ipynb\n", + " docs/**/* -- other content, copied over\n", + " docs/**/_template.html -- optional template, specifies the HTML template for this directory and its contents\n", + " docs/**/_template.tex -- optionally indicates Latex files should be generated\n", + " docs/**/_template.ipynb -- optionally indicates F# ipynb files should be generated\n", + " docs/**/_template.fsx -- optionally indicates F# fsx files should be generated (even from markdown)\n", + " docs/reference/_template.html -- optionally specifies the default template for reference docs\n", + "\n", + "Processing is by these two commands:\n", + "\n", + " dotnet fsdocs build\n", + " dotnet fsdocs watch\n", + "\n", + "The output goes in `output/` by default. Processing is recursive, making this a form of static site generation.\n", + "\n", + "## Literate Scripts and Markdown Content\n", + "\n", + "The input directory may contain [literate scripts](literate.html) and markdown content.\n", + "\n", + "## Other Content\n", + "\n", + "Content that is not `*.fsx` or `*.md` is copied across.\n", + "\n", + "## Default Styling Content\n", + "\n", + "By default additional content such as `fsdocs-search.js`, `fsdocs-tips.js` and `fsdocs-default.css` are included in\n", + "the `content` directory of the output. This can be suppressed with `--nodefaultcontent` or by having your own\n", + "copy of this content in your `content` directory.\n", + "\n", + "## Ignored Content\n", + "\n", + "Any file or directory beginning with `.` is ignored.\n", + "\n", + "## Front matter\n", + "\n", + "Each content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags.\n", + "\n", + "For markdown, the format is:\n", + "\n", + "```\n", + "---\n", + "title: Some Title\n", + "category: Some Category\n", + "categoryindex: 2\n", + "index: 3\n", + "description: Some description\n", + "keywords: tag1, tag2, tag3\n", + "---\n", + "```\n", + "For F# scripts the frontmatter is in this form:\n", + "\n", + " (**\n", + " ---\n", + " title: A Literate Script\n", + " category: Examples\n", + " categoryindex: 2\n", + " index: 1\n", + " description: Some description\n", + " keywords: tag1, tag2, tag3\n", + " ---\n", + " *)\n", + "\n", + "All entries are optional.\n", + "The `categoryindex` determines the ordering of categories.\n", + "The `index` determines the ordering of within each category.\n", + "The `title` is used in the navigation bar instead of any title inferred from the document.\n", + "The `description` is used in `\u003cmeta name=\"description\"` as part of the `{{fsdocs-meta-tags}}` substitution.\n", + "The `keywords` are also used in a meta tag as part of `{{fsdocs-meta-tags}}`. Separate them using a `,`.\n", + "\n", + "## Link Translation for Inputs\n", + "\n", + "If an input is used in markdown as a target of a markdown direct link, then that is replaced by the output file. For example:\n", + "\n", + " [Some Text](some-file.md)\n", + "\n", + "becomes\n", + "\n", + " [Some Text](some-file.html)\n", + "\n", + "if `some-file.md` is one of the inputs.\n", + "\n", + "## Multi-language Content\n", + "\n", + "Versions of content in other languages should go in two-letter coded sub-directories, e.g.\n", + "\n", + " docs/ja/...\n", + " docs/de/...\n", + "\n", + "These will be elided from the main table-of-contents and search indexes. (Currently no language-specific\n", + "table of contents is built, nor language-specific site search indexes).\n", + "\n", + "## Templates and Substitutions\n", + "\n", + "Templates are used for HTML (`_template.html`), LaTeX (`_template.tex`), Notebooks (`_template.ipynb)`\n", + "and F# script outputs (`_template.fsx`).\n", + "\n", + "The following substitutions determine the primary (non-styling) content of your site.\n", + "For example `{{fsdocs-content}}` is replaced with the generated content in each file.\n", + "\n", + "Substitutions are applied when generating content from HTML templates, IPYNB templates, FSX templates.\n", + "They are also applied to content apart from Markdown inline code ``...``, Markdown LaTeX and\n", + "generated outputs.\n", + "\n", + "See [Styling](styling.html) for information about template parameters and styling beyond the default template.\n", + "\n", + "Substitution name | Generated content\n", + ":--- | :---\n", + "`root` | `\u003cPackageProjectUrl\u003e` else `/` followed by `fsdocs-collection-name`\n", + "`fsdocs-collection-name` | Name of .sln, single .fsproj or containing directory\n", + "`fsdocs-content` | Main page content\n", + "`fsdocs-list-of-namespaces` | HTML `\u003cli\u003e` list of namespaces with links\n", + "`fsdocs-list-of-documents` | HTML `\u003cli\u003e` list of documents with titles and links\n", + "`fsdocs-page-title` | First h1 heading in literate file. Generated for API docs\n", + "`fsdocs-source` | Original literate script or markdown source\n", + "`fsdocs-source-filename` | Name of original input source, relative to the `docs` root\n", + "`fsdocs-source-basename` | Name of original input source, excluding its extensions, relative to the `docs` root\n", + "`fsdocs-tooltips` | Generated hidden div elements for tooltips\n", + "`fsdocs-watch-script` | The websocket script used in watch mode to trigger hot reload\n", + "`fsdocs-previous-page-link` | A relative link to the previous page based on the frontmatter index data\n", + "`fsdocs-next-page-link` | A relative link to the next page based on the frontmatter index data\n", + "`fsdocs-head-extra` | Additional html content loaded from the `_head.html` file if present in the `--input` folder\n", + "`fsdocs-body-extra` | Additional html content loaded from the `_body.html` file if present in the `--input` folder\n", + "`fsdocs-body-class` | A css class value to help distinguish between `content` and `api-docs`\n", + "`fsdocs-meta-tags` | A set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter\n", + "\n", + "\n", + "The following substitutions are extracted from your project files and may or may not be used by the default\n", + "template:\n", + "\n", + "Substitution name | Value\n", + ":--- | :---\n", + "`fsdocs-copyright` | `\u003cCopyright\u003e`\n", + "`fsdocs-package-project-url` | `\u003cPackageProjectUrl\u003e`\n", + "`fsdocs-package-license-expression` | `\u003cPackageLicenseExpression\u003e`\n", + "`fsdocs-package-tags` | `\u003cPackageTags\u003e`\n", + "`fsdocs-package-version` | `\u003cVersion\u003e`\n", + "\n", + "\n", + "For the `fsdocs` tool, additional substitutions can be specified using `--parameters`.\n", + "\n", + "## Cross References to API Docs\n", + "\n", + "Markdown content can contain cross-references to API Docs. Use inline\n", + "markdown code snippets of the special form ``cref:T:MyNamespace.MyType`` where `T:MyNamespace.MyType`\n", + "is a method, property or type xml doc sig reference, see [API Docs](apidocs.html).\n", + "This can include any cross-references resolved by fsdocs.\n", + "\n", + "The generated API documentation includes buttons to copy the XML and Markdown forms of API doc references.\n", + "\n", + "For example, within this project,\n", + "\n", + "* the text ``cref:T:FSharp.Formatting.Markdown.MarkdownParagraph`` resolves to the link [MarkdownParagraph](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html)\n", + " \n", + "\n", + "* the text ``cref:T:System.Console`` resolves to the link [Console](https://learn.microsoft.com/dotnet/api/system.console)\n", + " \n", + "\n", + "* the text ``cref:M:System.Console.WriteLine`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline)\n", + " \n", + "\n", + "* the text ``cref:M:System.Console.WriteLine(System.String)`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline)\n", + " \n", + "\n", + "* the text ```cref:T:FSharp.Control.FSharpAsync`1``` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync-1)\n", + " \n", + "\n", + "* the text ``cref:T:FSharp.Control.FSharpAsync`` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync)\n", + " \n", + "\n", + "* the text ```cref:T:FSharp.Core.array`1``` resolves to the link [array](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-array-1)\n", + " \n", + "\n", + "* the text ``cref:T:FSharp.Core.OptionModule`` resolves to the link [Option](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-optionmodule)\n", + " \n", + "\n", + "* the text ````cref:M:FSharp.Collections.ListModule.Append``1```` resolves to the link [ListModule.Append](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule#Append)\n", + " \n", + "\n", + "\u003e NOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the\n", + "external link. [Please report it](https://github.com/fsprojects/FSharp.Formatting/issues/new).\n", + "\u003e \n", + "\n", + "Determining xmldoc sig references is not simple. The API doc generated pages come with\n", + "buttons to copy out the XmlDoc signature.\n", + "\n", + "## Generating HTML Output\n", + "\n", + "HTML is generated by default. You can also add a `_template.html`. This should contain `{{fsdocs-content}}`, `{{fsdocs-tooltips}}`\n", + "and other placeholders. Substitutions are\n", + "applied to this template.\n", + "If a file `_template.html` exists, then it\u0027s used as the template for HTML generation for that directory and all sub-content.\n", + "\n", + "## Generating LaTeX output\n", + "\n", + "To generate .tex output for each script and markdown file, add a `_template.tex`. Substitutions are\n", + "applied to this template. The file is either empty or contains `{{fsdocs-content}}` as the key where the body\n", + "of the document is placed.\n", + "\n", + "## Generating iPython Notebook output\n", + "\n", + "To generate .ipynb output for each script and markdown file, add a `_template.ipynb`, usually empty. Substitutions are\n", + "applied to this template.\n", + "\n", + "To add a `mybinder` badge to your generated notebook, ensure you have a `Dockerfile` and `NuGet.config`\n", + "in your `docs` directory and use text like this:\n", + "\n", + " [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)\n", + "\n", + "## Generating Script outputs\n", + "\n", + "To generate .fsx output for each script and markdown file, add a `_template.fsx`, usually empty. Substitutions are\n", + "applied to this template. It is either empty or contains `{{fsdocs-content}}` as the key where the body\n", + "of the script is placed.\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/content.md b/content.md new file mode 100644 index 000000000..c140075f6 --- /dev/null +++ b/content.md @@ -0,0 +1,245 @@ +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=content.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//content.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//content.ipynb) + +# Creating Content + +The ["fsdocs" tool](commandline.html) allows documentation for a site to be built +from content in a `docs` directory. The expected structure for a `docs` directory is + +docs/**/*.md -- markdown with embedded code, converted to html and optionally tex/ipynb +docs/**/*.fsx -- fsx scripts converted to html and optionally tex/ipynb +docs/**/* -- other content, copied over +docs/**/_template.html -- optional template, specifies the HTML template for this directory and its contents +docs/**/_template.tex -- optionally indicates Latex files should be generated +docs/**/_template.ipynb -- optionally indicates F# ipynb files should be generated +docs/**/_template.fsx -- optionally indicates F# fsx files should be generated (even from markdown) +docs/reference/_template.html -- optionally specifies the default template for reference docs + +Processing is by these two commands: + +```fsharp +dotnet fsdocs build +dotnet fsdocs watch + +``` + +The output goes in `output/` by default. Processing is recursive, making this a form of static site generation. + +## Literate Scripts and Markdown Content + +The input directory may contain [literate scripts](literate.html) and markdown content. + +## Other Content + +Content that is not `*.fsx` or `*.md` is copied across. + +## Default Styling Content + +By default additional content such as `fsdocs-search.js`, `fsdocs-tips.js` and `fsdocs-default.css` are included in +the `content` directory of the output. This can be suppressed with `--nodefaultcontent` or by having your own +copy of this content in your `content` directory. + +## Ignored Content + +Any file or directory beginning with `.` is ignored. + +## Front matter + +Each content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags. + +For markdown, the format is: + +```fsharp +--- +title: Some Title +category: Some Category +categoryindex: 2 +index: 3 +description: Some description +keywords: tag1, tag2, tag3 +--- + +``` + +For F# scripts the frontmatter is in this form: + +```fsharp +(** +--- +title: A Literate Script +category: Examples +categoryindex: 2 +index: 1 +description: Some description +keywords: tag1, tag2, tag3 +--- +*) + +``` + +All entries are optional. +The `categoryindex` determines the ordering of categories. +The `index` determines the ordering of within each category. +The `title` is used in the navigation bar instead of any title inferred from the document. +The `description` is used in `` else `/` followed by `fsdocs-collection-name` +`fsdocs-collection-name` | Name of .sln, single .fsproj or containing directory +`fsdocs-content` | Main page content +`fsdocs-list-of-namespaces` | HTML `
              • ` list of namespaces with links +`fsdocs-list-of-documents` | HTML `
              • ` list of documents with titles and links +`fsdocs-page-title` | First h1 heading in literate file. Generated for API docs +`fsdocs-source` | Original literate script or markdown source +`fsdocs-source-filename` | Name of original input source, relative to the `docs` root +`fsdocs-source-basename` | Name of original input source, excluding its extensions, relative to the `docs` root +`fsdocs-tooltips` | Generated hidden div elements for tooltips +`fsdocs-watch-script` | The websocket script used in watch mode to trigger hot reload +`fsdocs-previous-page-link` | A relative link to the previous page based on the frontmatter index data +`fsdocs-next-page-link` | A relative link to the next page based on the frontmatter index data +`fsdocs-head-extra` | Additional html content loaded from the `_head.html` file if present in the `--input` folder +`fsdocs-body-extra` | Additional html content loaded from the `_body.html` file if present in the `--input` folder +`fsdocs-body-class` | A css class value to help distinguish between `content` and `api-docs` +`fsdocs-meta-tags` | A set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter + + +The following substitutions are extracted from your project files and may or may not be used by the default +template: + +Substitution name | Value +:--- | :--- +`fsdocs-copyright` | `` +`fsdocs-package-project-url` | `` +`fsdocs-package-license-expression` | `` +`fsdocs-package-tags` | `` +`fsdocs-package-version` | `` + + +For the `fsdocs` tool, additional substitutions can be specified using `--parameters`. + +## Cross References to API Docs + +Markdown content can contain cross-references to API Docs. Use inline +markdown code snippets of the special form ``cref:T:MyNamespace.MyType`` where `T:MyNamespace.MyType` +is a method, property or type xml doc sig reference, see [API Docs](apidocs.html). +This can include any cross-references resolved by fsdocs. + +The generated API documentation includes buttons to copy the XML and Markdown forms of API doc references. + +For example, within this project, + +* the text ``cref:T:FSharp.Formatting.Markdown.MarkdownParagraph`` resolves to the link [MarkdownParagraph](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html) + + +* the text ``cref:T:System.Console`` resolves to the link [Console](https://learn.microsoft.com/dotnet/api/system.console) + + +* the text ``cref:M:System.Console.WriteLine`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline) + + +* the text ``cref:M:System.Console.WriteLine(System.String)`` resolves to the link [Console.WriteLine](https://learn.microsoft.com/dotnet/api/system.console.writeline) + + +* the text ```cref:T:FSharp.Control.FSharpAsync`1``` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync-1) + + +* the text ``cref:T:FSharp.Control.FSharpAsync`` resolves to the link [Async](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync) + + +* the text ```cref:T:FSharp.Core.array`1``` resolves to the link [array](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-array-1) + + +* the text ``cref:T:FSharp.Core.OptionModule`` resolves to the link [Option](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-optionmodule) + + +* the text ````cref:M:FSharp.Collections.ListModule.Append``1```` resolves to the link [ListModule.Append](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule#Append) + + +> NOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the +external link. [Please report it](https://github.com/fsprojects/FSharp.Formatting/issues/new). +> + +Determining xmldoc sig references is not simple. The API doc generated pages come with +buttons to copy out the XmlDoc signature. + +## Generating HTML Output + +HTML is generated by default. You can also add a `_template.html`. This should contain `{{fsdocs-content}}`, `{{fsdocs-tooltips}}` +and other placeholders. Substitutions are +applied to this template. +If a file `_template.html` exists, then it's used as the template for HTML generation for that directory and all sub-content. + +## Generating LaTeX output + +To generate .tex output for each script and markdown file, add a `_template.tex`. Substitutions are +applied to this template. The file is either empty or contains `{{fsdocs-content}}` as the key where the body +of the document is placed. + +## Generating iPython Notebook output + +To generate .ipynb output for each script and markdown file, add a `_template.ipynb`, usually empty. Substitutions are +applied to this template. + +To add a `mybinder` badge to your generated notebook, ensure you have a `Dockerfile` and `NuGet.config` +in your `docs` directory and use text like this: + +```fsharp +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb) + +``` + +## Generating Script outputs + +To generate .fsx output for each script and markdown file, add a `_template.fsx`, usually empty. Substitutions are +applied to this template. It is either empty or contains `{{fsdocs-content}}` as the key where the body +of the script is placed. + + diff --git a/content.tex b/content.tex new file mode 100644 index 000000000..47b2b9c71 --- /dev/null +++ b/content.tex @@ -0,0 +1,375 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + + + +\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=content.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-binder.svg} +\caption{Binder} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//content.fsx}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-script.svg} +\caption{Script} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//content.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg} +\caption{Notebook} +\end{figure} +} +\section*{Creating Content} + + + +The \href{commandline.html}{"fsdocs" tool} allows documentation for a site to be built +from content in a \texttt{docs} directory. The expected structure for a \texttt{docs} directory is +\begin{lstlisting} +docs/**/*.md -- markdown with embedded code, converted to html and optionally tex/ipynb +docs/**/*.fsx -- fsx scripts converted to html and optionally tex/ipynb +docs/**/* -- other content, copied over +docs/**/_template.html -- optional template, specifies the HTML template for this directory and its contents +docs/**/_template.tex -- optionally indicates Latex files should be generated +docs/**/_template.ipynb -- optionally indicates F# ipynb files should be generated +docs/**/_template.fsx -- optionally indicates F# fsx files should be generated (even from markdown) +docs/reference/_template.html -- optionally specifies the default template for reference docs + +\end{lstlisting} + + +Processing is by these two commands: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\id{dotnet} \id{fsdocs} \id{build} +\id{dotnet} \id{fsdocs} \id{watch} + + +\end{lstlisting} + + + +The output goes in \texttt{output/} by default. Processing is recursive, making this a form of static site generation. +\subsection*{Literate Scripts and Markdown Content} + + + +The input directory may contain \href{literate.html}{literate scripts} and markdown content. +\subsection*{Other Content} + + + +Content that is not \texttt{*.fsx} or \texttt{*.md} is copied across. +\subsection*{Default Styling Content} + + + +By default additional content such as \texttt{fsdocs-search.js}, \texttt{fsdocs-tips.js} and \texttt{fsdocs-default.css} are included in +the \texttt{content} directory of the output. This can be suppressed with \texttt{--nodefaultcontent} or by having your own +copy of this content in your \texttt{content} directory. +\subsection*{Ignored Content} + + + +Any file or directory beginning with \texttt{.} is ignored. +\subsection*{Front matter} + + + +Each content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags. + + +For markdown, the format is: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +{---} +\id{title}{:} \id{Some} \id{Title} +\id{category}{:} \id{Some} \id{Category} +\id{categoryindex}{:} \num{2} +\id{index}{:} \num{3} +\id{description}{:} \id{Some} \id{description} +\id{keywords}{:} \id{tag1}{,} \id{tag2}{,} \id{tag3} +\ops{---} + + +\end{lstlisting} + + + +For F\# scripts the frontmatter is in this form: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{(**} +\com{---} +\com{title: A Literate Script} +\com{category: Examples} +\com{categoryindex: 2} +\com{index: 1} +\com{description: Some description} +\com{keywords: tag1, tag2, tag3} +\com{---} +\com{*)} + + +\end{lstlisting} + + + +All entries are optional. +The \texttt{categoryindex} determines the ordering of categories. +The \texttt{index} determines the ordering of within each category. +The \texttt{title} is used in the navigation bar instead of any title inferred from the document. +The \texttt{description} is used in \texttt{} else \texttt{/} followed by \texttt{fsdocs-collection-name}\\ \hline +\texttt{fsdocs-collection-name} & Name of .sln, single .fsproj or containing directory\\ \hline +\texttt{fsdocs-content} & Main page content\\ \hline +\texttt{fsdocs-list-of-namespaces} & HTML \texttt{
              • } list of namespaces with links\\ \hline +\texttt{fsdocs-list-of-documents} & HTML \texttt{
              • } list of documents with titles and links\\ \hline +\texttt{fsdocs-page-title} & First h1 heading in literate file. Generated for API docs\\ \hline +\texttt{fsdocs-source} & Original literate script or markdown source\\ \hline +\texttt{fsdocs-source-filename} & Name of original input source, relative to the \texttt{docs} root\\ \hline +\texttt{fsdocs-source-basename} & Name of original input source, excluding its extensions, relative to the \texttt{docs} root\\ \hline +\texttt{fsdocs-tooltips} & Generated hidden div elements for tooltips\\ \hline +\texttt{fsdocs-watch-script} & The websocket script used in watch mode to trigger hot reload\\ \hline +\texttt{fsdocs-previous-page-link} & A relative link to the previous page based on the frontmatter index data\\ \hline +\texttt{fsdocs-next-page-link} & A relative link to the next page based on the frontmatter index data\\ \hline +\texttt{fsdocs-head-extra} & Additional html content loaded from the \texttt{\_head.html} file if present in the \texttt{--input} folder\\ \hline +\texttt{fsdocs-body-extra} & Additional html content loaded from the \texttt{\_body.html} file if present in the \texttt{--input} folder\\ \hline +\texttt{fsdocs-body-class} & A css class value to help distinguish between \texttt{content} and \texttt{api-docs}\\ \hline +\texttt{fsdocs-meta-tags} & A set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter\\ \hline +\end{tabular} + + + +The following substitutions are extracted from your project files and may or may not be used by the default +template: +\begin{tabular}{|l|l|}\hline +\textbf{Substitution name} & \textbf{Value}\\ \hline\hline +\texttt{fsdocs-copyright} & \texttt{}\\ \hline +\texttt{fsdocs-package-project-url} & \texttt{}\\ \hline +\texttt{fsdocs-package-license-expression} & \texttt{}\\ \hline +\texttt{fsdocs-package-tags} & \texttt{}\\ \hline +\texttt{fsdocs-package-version} & \texttt{}\\ \hline +\end{tabular} + + + +For the \texttt{fsdocs} tool, additional substitutions can be specified using \texttt{--parameters}. +\subsection*{Cross References to API Docs} + + + +Markdown content can contain cross-references to API Docs. Use inline +markdown code snippets of the special form \texttt{`cref:T:MyNamespace.MyType`} where \texttt{T:MyNamespace.MyType} +is a method, property or type xml doc sig reference, see \href{apidocs.html}{API Docs}. +This can include any cross-references resolved by fsdocs. + + +The generated API documentation includes buttons to copy the XML and Markdown forms of API doc references. + + +For example, within this project, +\begin{itemize} +\item + +the text \texttt{`cref:T:FSharp.Formatting.Markdown.MarkdownParagraph`} resolves to the link \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html}{MarkdownParagraph} + +\item + +the text \texttt{`cref:T:System.Console`} resolves to the link \href{https://learn.microsoft.com/dotnet/api/system.console}{Console} + +\item + +the text \texttt{`cref:M:System.Console.WriteLine`} resolves to the link \href{https://learn.microsoft.com/dotnet/api/system.console.writeline}{Console.WriteLine} + +\item + +the text \texttt{`cref:M:System.Console.WriteLine(System.String)`} resolves to the link \href{https://learn.microsoft.com/dotnet/api/system.console.writeline}{Console.WriteLine} + +\item + +the text \texttt{``cref:T:FSharp.Control.FSharpAsync`1``} resolves to the link \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync-1}{Async} + +\item + +the text \texttt{`cref:T:FSharp.Control.FSharpAsync`} resolves to the link \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync}{Async} + +\item + +the text \texttt{``cref:T:FSharp.Core.array`1``} resolves to the link \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-array-1}{array} + +\item + +the text \texttt{`cref:T:FSharp.Core.OptionModule`} resolves to the link \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-optionmodule}{Option} + +\item + +the text \texttt{```cref:M:FSharp.Collections.ListModule.Append``1```} resolves to the link \href{https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule\#Append}{ListModule.Append} + +\end{itemize} + +\begin{quote} + + +NOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the +external link. \href{https://github.com/fsprojects/FSharp.Formatting/issues/new}{Please report it}. +\end{quote} + + + +Determining xmldoc sig references is not simple. The API doc generated pages come with +buttons to copy out the XmlDoc signature. +\subsection*{Generating HTML Output} + + + +HTML is generated by default. You can also add a \texttt{\_template.html}. This should contain \texttt{\{\{fsdocs-content\}\}}, \texttt{\{\{fsdocs-tooltips\}\}} +and other placeholders. Substitutions are +applied to this template. +If a file \texttt{\_template.html} exists, then it's used as the template for HTML generation for that directory and all sub-content. +\subsection*{Generating LaTeX output} + + + +To generate .tex output for each script and markdown file, add a \texttt{\_template.tex}. Substitutions are +applied to this template. The file is either empty or contains \texttt{\{\{fsdocs-content\}\}} as the key where the body +of the document is placed. +\subsection*{Generating iPython Notebook output} + + + +To generate .ipynb output for each script and markdown file, add a \texttt{\_template.ipynb}, usually empty. Substitutions are +applied to this template. + + +To add a \texttt{mybinder} badge to your generated notebook, ensure you have a \texttt{Dockerfile} and \texttt{NuGet.config} +in your \texttt{docs} directory and use text like this: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +{[}\ops{!}{[}\id{Binder}{]}{(}\id{https}{:}\com{//mybinder.org/badge\_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)} + + +\end{lstlisting} + +\subsection*{Generating Script outputs} + + + +To generate .fsx output for each script and markdown file, add a \texttt{\_template.fsx}, usually empty. Substitutions are +applied to this template. It is either empty or contains \texttt{\{\{fsdocs-content\}\}} as the key where the body +of the script is placed. + + +\end{document} \ No newline at end of file diff --git a/content/fsdocs-default.css b/content/fsdocs-default.css new file mode 100644 index 000000000..7dea22869 --- /dev/null +++ b/content/fsdocs-default.css @@ -0,0 +1,1288 @@ +:root { + --monospace-font: "Fira Code", monospace; + --system-font: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; + --heading-font-family: var(--system-font); + + --spacing-50: 4px; + --spacing-100: 8px; + --spacing-200: 12px; + --spacing-300: 16px; + --spacing-400: 24px; + --spacing-500: 32px; + --spacing-600: 48px; + --spacing-700: 64px; + --spacing-800: 96px; + --spacing-900: 128px; + --spacing-950: 192px; + + --font-50: 12px; + --font-100: 14px; + --font-200: 16px; + --font-300: 18px; + --font-400: 20px; + --font-500: 24px; + --font-600: 30px; + --font-700: 36px; + --font-800: 48px; + --font-900: 60px; + --font-950: 72px; + + --line-height: 1.5; + --heading-line-height: 1.25; + --radius: 6px; + + --container-sm: 768px; + --container-md: 960px; + --container-lg: 1024px; + --container-xl: 1200px; + --container-xxl: 1400px; + --container-xxxl: 1800px; + --main-menu-width: 260px; + --page-menu-width: var(--main-menu-width); + --header-height: 60px; + --body-grid-template-columns: var(--main-menu-width) minmax(0, 1fr); + --body-grid-template-columns-xl: var(--main-menu-width) minmax(0, 1fr) var(--page-menu-width); + --main-menu-grid-row: 2; + --main-menu-grid-column: 1; + --main-grid-row: 2; + --main-grid-column: 2; + --dialog-width: 500px; + --api-docs-first-column-min-width: 320px; + --api-docs-second-column-min-width: 240px; + + /* light theme */ + --primary: #1e8bc3; + --background: #f5f5f6; + --text-color: #020202; + --text-hover: #282828; + --heading-color: #2e293a; + --code-background: #ffffff; + --code-color: #1a4b0b; + --header-background: #f9fbfc; + --header-border: #e8ecf1; + --header-link-color: var(--text-color); + --mobile-menu-background: var(--header-background); + --menu-color: var(--text-color); + --menu-item-hover-background: #eff0f1; + --menu-item-hover-color: var(--menu-color); + --doc-tip-background: #F7F7F7; + --link-color: #4871f7; + --link-hover: #91aafa; + --search-background: rgb(229, 231, 235); + --nav-category: rgb(156, 163, 175); + --scrollbar-track-background: #424242; + --scrollbar-track-border: #4A4A4A; + --scrollbar-thumb-background: #686868; + --shadow-color: hsla(0, 0%, 0%, .1); + --main-shadow-color: hsla(0, 0%, 0%, .025); + --aside-background: var(--header-background); + --blockquote-bacground-color: var(--header-background); + --blockquote-color: var(--text-color); + --on-this-page-color: var(--menu-color); + --page-menu-background-color: var(--header-background); + --page-menu-background-border-color: var(--header-border); + --page-menu-background-hover-border-color: var(--text-color); + --nav-item-border-color: var(--header-border); + --nav-item-active-border-color: var(--text-color); + --dialog-background-color: var(--header-background); + --dialog-empty-color: var(--nav-category); + --dialog-icon-color: var(--text-color); + --dialog-link-color: var(--link-color); + --dialog-link-hover-color: var(--header-background); + --dialog-link-hover-background-color: var(--link-hover); + --code-fence-border-color: transparent; + + --header-brand-text-transform: none; + + --code-strings-color: #0093A1; + --code-printf-color: #6B2FBA; + --code-escaped-color: #EA8675; + --code-identifiers-color: #6B2FBA; + --code-module-color: #009999; + --code-reference-color: #4974D1; + --code-value-color: #1B6600; + --code-interface-color: #43AEC6; + --code-typearg-color: #43AEC6; + --code-disposable-color: #43AEC6; + --code-property-color: #43AEC6; + --code-punctuation-color: #43AEC6; + --code-punctuation2-color: var(--text-color); + --code-function-color: #6B2FBA; + --code-function2-color: #6B2FBA; + --code-activepattern-color: #4ec9b0; + --code-unioncase-color: #4ec9b0; + --code-enumeration-color: #8C6C41; + --code-keywords-color: #0F54D6; + --code-comment-color: #707070; + --code-operators-color: #0F54D6; + --code-numbers-color: #009999; + --code-linenumbers-color: #80b0b0; + --code-mutable-color: #1b6600; + --code-inactive-color: #808080; + --code-preprocessor-color: #af75c1; + --code-fsioutput-color: #808080; + --code-tooltip-color: #d1d1d1; +} + +/* dark theme */ + +[data-theme=dark] { + --primary: #81cfe0; + --background: rgb(20, 21, 26); + --text-color: #F7F7F7; + --text-hover: #FFF; + --heading-color: rgb(229, 231, 235); + --code-background: #28282D; + --code-color: #f5f5f6; + --header-background: #0c1318; + --header-border: #9b9b9b; + --menu-item-hover-background: #2c2624; + --doc-tip-background: #2e293a; + --link-color: #c5eff7; + --search-background: #020202; + --nav-category: rgb(207, 211, 215); + --code-strings-color: #86b4b9; + --code-printf-color: #6B2FBA; + --code-escaped-color: #EA8675; + --code-identifiers-color: #d1b3f5; + --code-module-color: #15e1e1; + --code-reference-color: #40fddd; + --code-value-color: #ffb4e9; + --code-interface-color: #43AEC6; + --code-typearg-color: #43AEC6; + --code-disposable-color: #6dd6f1; + --code-property-color: #6acfe7; + --code-punctuation-color: #43AEC6; + --code-punctuation2-color: var(--text-color); + --code-function-color: #6B2FBA; + --code-function2-color: #cbda9d; + --code-activepattern-color: #4ec9b0; + --code-unioncase-color: #4ec9b0; + --code-enumeration-color: #8C6C41; + --code-keywords-color: #a7c2f8; + --code-comment-color: #84d16e; + --code-operators-color: #b4c6ee; + --code-numbers-color: #009999; + --code-linenumbers-color: #80b0b0; + --code-mutable-color: #1b6600; + --code-inactive-color: #808080; + --code-preprocessor-color: #af75c1; + --code-fsioutput-color: #808080; + --code-tooltip-color: #d1d1d1; +} + +/* CSS Reset, source: https://www.joshwcomeau.com/css/custom-css-reset/ */ +*, *::before, *::after { + box-sizing: border-box; +} + +* { + margin: 0; +} + +html { + overflow-y: hidden; +} + +body { + line-height: 1.5; + -webkit-font-smoothing: antialiased; +} + +picture, video, canvas, svg { + display: block; + max-width: 100%; +} + +input, button, textarea, select { + font: inherit; +} + +p, h1, h2, h3, h4, h5, h6 { + overflow-wrap: break-word; +} + +/* Main layout */ +body { + font-family: var(--system-font); + background-color: var(--background); + color: var(--text-color); + line-height: var(--line-height); + scroll-padding-top: var(--header-height); + scroll-behavior: smooth; +} + +header { + background-color: var(--header-background); + padding: var(--spacing-300); + height: var(--header-height); + display: flex; + align-items: center; + justify-content: space-between; + position: sticky; + top: 0; + z-index: 100; + box-shadow: 0 1px 1px var(--shadow-color); + + & .start { + display: flex; + align-items: center; + + & #menu-toggle { + position: relative; + height: var(--spacing-500); + width: var(--spacing-500); + border: 1px solid var(--header-border); + border-radius: var(--radius); + box-shadow: 0 1px 1px var(--shadow-color); + + & .icon { + top: 4px; + left: 4px; + width: calc(var(--spacing-500) - 4px); + height: calc(var(--spacing-500) - 4px); + position: absolute; + color: var(--header-link-color); + + &.open { + display: none; + } + } + + & input[type=checkbox] { + position: absolute; + width: 100%; + height: 100%; + left: 0; + top: 0; + appearance: none; + cursor: pointer; + } + + & .menu { + visibility: hidden; + height: 0; + opacity: 0; + width: 100%; + transition: all 0.2s ease-in-out; + position: fixed; + top: var(--header-height); + left: 0; + background-color: var(--mobile-menu-background); + list-style: none; + padding: var(--spacing-300); + overflow-y: auto; + } + + & input:checked + .menu { + visibility: visible; + opacity: 1; + height: calc(100vh - var(--header-height)); + } + + &:has(input:checked) { + .icon.open { + display: block; + } + + .icon.closed { + display: none; + } + } + } + + > a { + display: flex; + justify-content: center; + align-items: center; + text-decoration: none; + color: var(--header-link-color); + } + + & img { + margin: 0 var(--spacing-200); + border-radius: var(--radius); + height: calc(var(--spacing-500) - 2px); + } + + & strong { + line-height: var(--spacing-500); + font-size: var(--font-200); + display: block; + text-transform: var(--header-brand-text-transform); + font-weight: 500; + } + } + + & .end { + display: flex; + align-items: center; + + & a { + display: none; + color: var(--header-link-color); + } + + & > .themeToggle, & > .search { + cursor: pointer; + height: var(--spacing-500); + align-items: center; + margin: 0 var(--spacing-100); + } + + & > .search { + display: flex; + color: var(--header-link-color); + } + } +} + +aside { + display: none; +} + +main { + height: calc(100dvh - var(--header-height)); +} + +#content { + padding: var(--spacing-300); + + > *:first-child { + margin-top: 0; + } +} + +#fsdocs-page-menu { + display: none; + padding: var(--spacing-300); + background-color: var(--page-menu-background-color); + border-left: 1px solid var(--page-menu-background-border-color); + + &:has(.empty) { + display: none; + } + + > #on-this-page { + font-size: var(--font-100); + line-height: 1.5; + color: var(--on-this-page-color); + font-weight: 500; + margin: 0 0 var(--spacing-50); + } + + & ul { + list-style: none; + padding: 0; + margin: 0; + + & li { + border-left: 1px solid var(--header-border); + margin: 0; + + &:hover, &:focus { + border-color: var(--page-menu-background-hover-border-color); + } + + & a { + color: var(--menu-color); + text-decoration: none; + padding: var(--spacing-50) var(--spacing-100); + display: block; + overflow-x: hidden; + text-overflow: ellipsis; + } + + &.level-3 { + padding-left: var(--spacing-100); + } + + &.level-4 { + padding-left: var(--spacing-300); + } + } + } +} + +/* menu items */ +.menu { + padding: 0; + + & li { + list-style: none; + margin: 0; + } + + .nav-header { + margin-top: var(--spacing-300); + text-transform: uppercase; + font-size: var(--font-200); + font-weight: 500; + color: var(--menu-color); + } +} + +.nav-header:first-child { + margin-top: 0; +} + +.nav-item { + border-left: 1px solid var(--nav-item-border-color); + + & a { + color: var(--menu-color); + text-decoration: none; + font-size: var(--font-200); + padding: var(--spacing-100); + display: block; + overflow-x: hidden; + text-overflow: ellipsis; + + &:hover { + background-color: var(--menu-item-hover-background); + color: var(--menu-item-hover-color); + } + } + + &:hover, &.active { + border-color: var(--nav-item-active-border-color); + } + + &.active { + font-weight: 600; + } +} + +@media screen and (min-width: 768px) { + #menu-toggle { + display: none; + } + + body { + display: grid; + grid-template-rows: var(--header-height) minmax(0, 1fr); + grid-template-columns:var(--body-grid-template-columns); + gap: 0; + } + + header { + border-bottom: 1px solid var(--header-border); + grid-row: 1; + grid-column: span 2; + box-shadow: none; + + & .end { + > a { + display: flex; + align-items: center; + text-decoration: none; + + &:hover { + color: var(--link-hover); + } + } + } + } + + aside, main { + height: calc(100vh - var(--header-height)); + } + + aside { + position: sticky; + top: var(--header-height); + } + + #fsdocs-main-menu { + display: block; + padding: var(--spacing-300) var(--spacing-500); + background-color: var(--aside-background); + width: var(--main-menu-width); + border-right: 1px solid var(--header-border); + grid-row: var(--main-menu-grid-row); + grid-column: var(--main-menu-grid-column); + overflow-y: auto; + } + + main { + grid-row: var(--main-grid-row); + grid-column: var(--main-grid-column); + box-shadow: inset 1px 1px var(--main-shadow-color); + border-radius: 0; + } + + #content { + padding-left: var(--spacing-300); + padding-right: var(--spacing-300); + } +} + +@media screen and (min-width: 768px) { + #content { + max-width: calc(100vw - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + margin: 0 auto; + } +} + +@media screen and (min-width: 960px) { + #content { + max-width: calc(var(--container-md) - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + } +} + +@media screen and (min-width: 1024px) { + #content { + max-width: calc(var(--container-lg) - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + } +} + +@media screen and (min-width: 1200px) { + body { + grid-template-columns: var(--body-grid-template-columns-xl); + + &.api-docs { + grid-template-columns: var(--body-grid-template-columns); + + #content { + max-width: calc(var(--container-xl) - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + } + + #fsdocs-page-menu { + display: none; + } + } + } + + header { + grid-column: span 3; + } + + #fsdocs-page-menu { + grid-column: 3; + display: block; + } + + #content { + max-width: calc(var(--container-xl) - var(--main-menu-width) - var(--page-menu-width) - var(--spacing-300) - var(--spacing-300)); + } +} + +@media screen and (min-width: 1400px) { + body { + &.api-docs, &:has(#fsdocs-page-menu .empty) { + #content { + max-width: calc(var(--container-xxl) - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + } + } + } + + #content { + max-width: calc(var(--container-xxl) - var(--main-menu-width) - var(--page-menu-width) - var(--spacing-300) - var(--spacing-300)); + } +} + +@media screen and (min-width: 1800px) { + body { + &.api-docs, &:has(#fsdocs-page-menu .empty) { + #content { + max-width: calc(var(--container-xxxl) - var(--main-menu-width) - var(--spacing-300) - var(--spacing-300)); + } + } + } + + #content { + max-width: calc(var(--container-xxxl) - var(--main-menu-width) - var(--page-menu-width) - var(--spacing-300) - var(--spacing-300)); + } +} + +/* Headings */ +h1, h2, h3, h4, h5, h6 { + font-family: var(--heading-font-family); +} + +h1 a, h2 a, h3 a, h4 a, h5 a, h6 a { + color: var(--heading-color); + text-decoration: none; +} + +h1 { + font-size: var(--font-600); + line-height: var(--heading-line-height); + margin-bottom: var(--spacing-400); + margin-top: var(--spacing-50); +} + +h2 { + font-size: var(--font-500); + line-height: var(--heading-line-height); + margin-top: var(--spacing-400); + margin-bottom: var(--spacing-300); +} + +h3 { + font-size: var(--font-400); + line-height: var(--heading-line-height); + margin-top: var(--spacing-300); + margin-bottom: var(--spacing-200); +} + +h4 { + font-weight: bold; +} + +h4, h5, h6 { + font-size: var(--font-300); + margin-top: var(--spacing-200); + margin-bottom: var(--spacing-200); +} + +@media screen and (min-width: 768px) { + h1 { + font-size: var(--font-800); + margin-bottom: var(--spacing-400); + line-height: var(--heading-line-height); + } + + h2 { + font-size: var(--font-700); + margin-top: var(--spacing-500); + margin-bottom: var(--spacing-400); + } + + h3 { + font-size: var(--font-600); + margin-top: var(--spacing-500); + margin-bottom: var(--spacing-200); + } + + h4 { + font-size: var(--font-500); + } + + h4, h5, h6 { + margin-top: var(--spacing-300); + } +} + +/* Common items */ +a { + color: var(--link-color); +} + +p { + line-height: 1.8; + margin-top: var(--spacing-300); +} + +ol, ul { + padding-left: var(--spacing-400); +} + +ol li, ul li { + margin: var(--spacing-100) 0; +} + +img { + max-width: 100%; +} + +#content > table { + margin: var(--spacing-300) 0; +} + +blockquote { + border-left: var(--spacing-50) solid var(--primary); + margin: var(--spacing-200) 0; + margin-left: var(--spacing-200); + padding: var(--spacing-100) var(--spacing-300); + background-color: var(--blockquote-bacground-color); + color: var(--blockquote-color); + + > p { + margin: 0; + padding: 0; + } +} + +@media screen and (min-width: 768px) { + blockquote { + margin-left: var(--spacing-400); + } +} + +/* Code snippets */ + +/* reset browser style */ +pre { + margin: 0; + padding: 0; +} + +code, table.pre, pre { + background-color: var(--code-background); + color: var(--code-color); + font-family: var(--monospace-font); + font-variant-ligatures: none; + font-size: var(--font-200); + -webkit-text-size-adjust: 100%; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + font-size: inherit; +} + +table.pre, #content > pre.fssnip { + border: 1px solid var(--code-fence-border-color); +} + +table.pre, pre.fssnip.highlighted { + margin: var(--spacing-300) 0; + padding: var(--spacing-200); +} + +table.pre .snippet pre.fssnip { + padding: 0; + margin: 0; +} + +p > code, li > code { + padding: 2px var(--spacing-50); +} + +table.pre, pre > code { + display: block; +} + +pre.fssnip > code { + max-width: initial; + margin-bottom: initial; +} + +/* avoid problems with transparent background colors */ +pre.fssnip.highlighted > code, table.pre .fssnip, table.pre .fssnip code { + background-color: transparent; +} + +/* Custom scrollbar styling */ +body, aside, #menu-toggle .menu, table.pre, code, +.fsdocs-entity-xmldoc > div > pre, div.fsdocs-summary > pre, +dialog ul, div.fsdocs-tip, .fsdocs-xmldoc > pre { + overflow-x: auto; + max-width: 100%; + + &::-webkit-scrollbar { + height: var(--spacing-100); + width: var(--spacing-100); + } + + &::-webkit-scrollbar-track { + background-color: var(--scrollbar-track-background); + border: 1px solid var(--scrollbar-track-border); + } + + &::-webkit-scrollbar-thumb { + background-color: var(--scrollbar-thumb-background); + } +} + +body, aside, #menu-toggle .menu, table.pre, code, +.fsdocs-entity-xmldoc > div > pre, div.fsdocs-summary > pre, +dialog ul, div.fsdocs-tip, .fsdocs-xmldoc > pre { + @media screen and (min-width: 768px) { + &::-webkit-scrollbar { + height: var(--spacing-200); + width: var(--spacing-300); + } + } +} + +table.pre, code, pre.fssnip { + border-radius: var(--radius); +} + +/* Code coloring */ +.param-name, +.return-name, +.param { + font-weight: 900; + font-size: var(--font-100); + font-family: var(--monospace-font); + font-variant-ligatures: none; +} + +.fssnip { + /* strings --- and stlyes for other string related formats */ + + & span.s { + color: var(--code-strings-color); + } + + /* printf formatters */ + + & span.pf { + color: var(--code-printf-color); + } + + /* escaped chars */ + + & span.e { + color: var(--code-escaped-color); + } + + /* identifiers --- and styles for more specific identifier types */ + + & span.id { + color: var(--code-identifiers-color);; + } + + /* module */ + + & span.m { + color: var(--code-module-color); + } + + /* reference type */ + + & span.rt { + color: var(--code-reference-color); + } + + /* value type */ + + & span.vt { + color: var(--code-value-color); + } + + /* interface */ + + & span.if { + color: var(--code-interface-color); + } + + /* type argument */ + + & span.ta { + color: var(--code-typearg-color); + } + + /* disposable */ + + & span.d { + color: var(--code-disposable-color); + } + + /* property */ + + & span.prop { + color: var(--code-property-color); + } + + /* punctuation */ + + & span.p { + color: var(--code-punctuation-color); + } + + & span.pn { + color: var(--code-punctuation2-color); + } + + /* function */ + + & span.f { + color: var(--code-function-color); + } + + & span.fn { + color: var(--code-function2-color); + } + + /* active pattern */ + + & span.pat { + color: var(--code-activepattern-color); + } + + /* union case */ + + & span.u { + color: var(--code-unioncase-color); + } + + /* enumeration */ + + & span.e { + color: var(--code-enumeration-color); + } + + /* keywords */ + + & span.k { + color: var(--code-keywords-color); + } + + /* comment */ + + & span.c { + color: var(--code-comment-color); + font-weight: 400; + font-style: italic; + } + + /* operators */ + + & span.o { + color: var(--code-operators-color); + } + + /* numbers */ + + & span.n { + color: var(--code-numbers-color); + } + + /* line number */ + + & span.l { + color: var(--code-linenumbers-color); + } + + /* mutable var or ref cell */ + + & span.v { + color: var(--code-mutable-color); + font-weight: bold; + } + + /* inactive code */ + + & span.inactive { + color: var(--code-inactive-color); + } + + /* preprocessor */ + + & span.prep { + color: var(--code-preprocessor-color); + } + + /* fsi output */ + + & span.fsi { + color: var(--code-fsioutput-color); + } +} + +/* tooltips */ +div.fsdocs-tip { + z-index: 1000; + display: none; + background-color: var(--doc-tip-background); + border-radius: var(--radius); + border: 1px solid var(--header-border); + padding: var(--spacing-200); + font-family: var(--monospace-font); + font-variant-ligatures: none; + color: var(--code-color); + box-shadow: 0 1px 1px var(--shadow-color); + + & code { + color: var(--code-color); + } +} + +span[onmouseout] { + cursor: pointer; +} + +/* API docs */ +#content > div > h2:first-child { + margin-top: 0; +} + +.fsdocs-member-list-header { + display: flex; + flex-direction: row; + justify-content: space-between; + align-items: flex-start; +} + +.fsdocs-xmldoc { + & pre { + overflow-x: auto; + } +} + +.table { + width: 100%; + table-layout: fixed; + + & thead tr td { + font-weight: bold; + padding: var(--spacing-400) 0; + } + + & tr { + display: flex; + flex-flow: row wrap; + column-gap: var(--spacing-300); + + & td:first-of-type { + flex: 25 0 0; + min-width: var(--api-docs-first-column-min-width); + overflow-x: hidden; + text-overflow: ellipsis; + overflow-wrap: break-word; + + & p { + margin: unset; + } + } + + & td:nth-of-type(2) { + flex: 75 0 0; + min-width: var(--api-docs-second-column-min-width); + } + } + + & tbody td { + border-top: 1px solid var(--header-border); + padding: var(--spacing-300) 0; + } + + .fsdocs-entity-xmldoc { + > div { + display: flex; + flex-direction: row; + justify-content: space-between; + align-items: flex-start; + + & p.fsdocs-summary { + margin: 0; + flex-grow: 1; + } + + & pre { + margin-bottom: var(--spacing-200); + padding: var(--spacing-50); + flex-grow: 1; + overflow-x: auto; + } + } + } + + .fsdocs-summary-contents { + display: flex; + flex-direction: column; + justify-content: flex-start; + align-items: flex-start; + } + + .fsdocs-member-xmldoc-column { + width: 100%; + display: flex; + flex-direction: column; + justify-content: flex-start; + + > * { + margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); + + &:first-child:is(.icon-button-row) { + margin-block: 0; + } + + &:nth-child(2) { + margin-top: 0; + } + + &:last-child { + margin-bottom: 0; + } + } + } + + .icon-button-row { + display: flex; + flex-direction: row; + justify-content: flex-end; + align-items: flex-start; + height: calc(-1 * var(--spacing-200)); + } + + .fsdocs-member-xmldoc { + & summary { + display: list-item; + counter-increment: list-item 0; + list-style: disclosure-closed outside; + cursor: pointer; + + > .fsdocs-summary { + display: flex; + flex-direction: row; + justify-content: space-between; + align-items: flex-start; + + & p.fsdocs-summary { + margin: 0; + flex-grow: 1; + } + + & pre { + margin-bottom: var(--spacing-200); + padding: var(--spacing-50); + flex-grow: 1; + overflow-x: auto; + } + } + } + + & details[open] summary { + list-style-type: disclosure-open; + margin-bottom: var(--spacing-200); + } + + & details > * { + margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); + + &:is(summary) { + margin-block: 0; + } + + &:first-child { + margin-top: 0; + } + + &:last-child { + margin-bottom: 0; + } + } + + .fsdocs-return-name, .fsdocs-param-name { + font-weight: 500; + } + + .fsdocs-param-docs p { + margin: var(--spacing-200) 0; + } + + .fsdocs-example-header { + font-size: var(--font-200); + } + + > div.fsdocs-summary { + display: flex; + flex-direction: row; + justify-content: space-between; + align-items: flex-start; + margin: 0 0 0 var(--spacing-300); + + & p { + margin: 0; + } + } + } +} + +.fsdocs-source-link { + display: none; + padding: 0 var(--spacing-100); + color: var(--text-color); + cursor: pointer; + height: var(--font-500); + width: var(--font-500); + margin: 0 var(--spacing-50); + + &:hover { + color: var(--primary); + } +} + +@media screen and (min-width: 768px) { + .fsdocs-source-link { + display: block; + } +} + +/* Search */ +::backdrop { + background-color: #020202; + opacity: 0.5; +} + +dialog { + background-color: var(--dialog-background-color); + margin: var(--spacing-700) auto; + padding: var(--spacing-100); + border: none; + opacity: 0; + visibility: hidden; + transition: all 0.2s ease-in-out; + border-radius: var(--radius); + width: var(--dialog-width); + + &[open] { + opacity: 1; + visibility: visible; + } + + & input[type=search] { + margin: 0; + display: block; + width: 100%; + padding: var(--spacing-200); + outline: 1px solid var(--primary); + border-radius: var(--radius); + border: none; + + &::placeholder { + font-size: var(--font-400); + } + } + + .empty { + color: var(--dialog-empty-color); + text-align: center; + font-size: var(--font-100); + margin: var(--spacing-100); + margin-bottom: 0; + } + + & ul { + overflow-y: auto; + max-height: calc(50vh - var(--spacing-700) - var(--spacing-700)); + list-style: none; + padding: 0; + + & li { + margin: 0; + border-bottom: 1px solid var(--header-border); + + &:hover { + & a, & a iconify-icon { + background-color: var(--dialog-link-hover-background-color); + color: var(--dialog-link-hover-color); + } + } + + & a { + display: flex; + padding: var(--spacing-300); + overflow-x: hidden; + color: var(--dialog-link-color); + + & iconify-icon { + color: var(--dialog-icon-color); + width: 24px; + margin-right: var(--spacing-200); + } + } + } + } +} + +/* Variables don't seem to work on ::backdrop */ +[data-theme=dark] { + ::backdrop { + opacity: 0.75; + } +} diff --git a/content/fsdocs-details-set-expanded.js b/content/fsdocs-details-set-expanded.js new file mode 100644 index 000000000..f1518cd1e --- /dev/null +++ b/content/fsdocs-details-set-expanded.js @@ -0,0 +1,9 @@ +const expandDetails = !!JSON.parse(localStorage.getItem('details-expanded')); + +addEventListener('load', _ => { + if (expandDetails) { + for (const details of document.getElementsByTagName('details')) { + details.setAttribute('open', 'true'); + } + } +}); diff --git a/content/fsdocs-details-toggle.js b/content/fsdocs-details-toggle.js new file mode 100644 index 000000000..b8a3f67b5 --- /dev/null +++ b/content/fsdocs-details-toggle.js @@ -0,0 +1,46 @@ +import { LitElement, html, css } from 'https://cdn.jsdelivr.net/gh/lit/dist@3/core/lit-core.min.js'; + +const detailsExpanded = !!JSON.parse(localStorage.getItem('details-expanded')); + +export class DetailsToggle extends LitElement { + static properties = { + _detailsExpanded: { state: true, type: Boolean }, + }; + + constructor() { + super(); + this._detailsExpanded = detailsExpanded; + document.addEventListener('detailstoggled', e => this._detailsExpanded = !!e?.detail?.expanding); + } + + static styles = css` + :host { + cursor: pointer; + } + `; + + toggleDetails() { + this._detailsExpanded = !this._detailsExpanded; + localStorage.setItem('details-expanded', JSON.stringify(this._detailsExpanded)); + if (this._detailsExpanded) { + for (const details of document.getElementsByTagName('details')) { + details.setAttribute('open', 'true'); + } + } else { + for (const details of document.getElementsByTagName('details')) { + details.removeAttribute('open'); + } + } + document.dispatchEvent(new CustomEvent('detailstoggled', { detail: { expanding: this._detailsExpanded } })); + } + + render() { + const icon = this._detailsExpanded ? 'carbon:collapse-categories' : 'carbon:expand-categories'; + const title = this._detailsExpanded ? 'Collapse details' : 'Expand details'; + return html` + + `; + } +} + +customElements.define('fsdocs-details-toggle', DetailsToggle); diff --git a/content/fsdocs-search.js b/content/fsdocs-search.js new file mode 100644 index 000000000..9e4c21de2 --- /dev/null +++ b/content/fsdocs-search.js @@ -0,0 +1,126 @@ +import Fuse from "https://esm.sh/fuse.js@7.0.0"; + +const searchBtn = document.querySelector("#search-btn"); + +function hideSearchBtn() { + // Hide search icon if we can't search in the first place. + searchBtn.style.display = 'none'; +} + +function debounce(mainFunction, delay) { + // Declare a variable called 'timer' to store the timer ID + let timer; + + // Return an anonymous function that takes in any number of arguments + return function (...args) { + // Clear the previous timer to prevent the execution of 'mainFunction' + clearTimeout(timer); + + // Set a new timer that will execute 'mainFunction' after the specified delay + timer = setTimeout(() => { + mainFunction(...args); + }, delay); + }; +} + +const root = document.documentElement.getAttribute("data-root"); +if (root && searchBtn) { + let fuse = null; + const searchIndexUrl = `${root}/index.json`; + fetch(searchIndexUrl, {}) + .then(response => response.json()) + .then(index => { + fuse = new Fuse(index, { + includeScore: true, + keys: ['uri', 'title', 'content', 'headings'], + includeMatches: true, + limit: 20, + ignoreLocation: true, + threshold: 0.6, + minMatchCharLength: 2, + ignoreFieldNorm: true, + shouldSort: true + }); + }) + .catch(() => { + hideSearchBtn(); + }) + + const searchDialog = document.querySelector("dialog"); + const empty = document.querySelector("dialog .empty"); + const resultsElement = document.querySelector("dialog ul"); + const searchBox = document.querySelector("dialog input[type=search]"); + + searchBtn.addEventListener("click", () => { + searchDialog.showModal(); + }) + + searchDialog.addEventListener("click", ev => { + if (ev.target.tagName === "DIALOG") { + searchBox.value = ''; + searchDialog.close() + } + }) + + function searchAux(searchTerm) { + if (!fuse) return; + + const results = fuse.search(searchTerm); + if (results.length === 0) { + clearResults(); + empty.textContent = "No results were found"; + } else { + if (location.hostname === 'localhost'){ + console.table(results); + } + + empty.style.display = 'none'; + const newResultNodes = + results + .map(result => { + const item = result.item; + const li = document.createElement("li"); + const a = document.createElement("a"); + a.setAttribute("href", item.uri); + const icon = document.createElement("iconify-icon"); + icon.setAttribute("width", "24"); + icon.setAttribute("height", "24"); + icon.setAttribute("icon", item.type === "content" ? "iconoir:page" : "bxs:file-doc") + a.append(icon, item.title); + li.appendChild(a); + return li; + }); + resultsElement.replaceChildren(...newResultNodes); + } + } + + const search = debounce(searchAux, 250); + + function clearResults() { + empty.style.display = 'block'; + resultsElement.replaceChildren(); + } + + searchBox.addEventListener('keyup', ev => { + ev.stopPropagation(); + const searchTerm = ev.target.value; + if (!searchTerm) { + empty.textContent = "Type something to start searching."; + clearResults(); + } else { + search(searchTerm); + } + }); + + window.addEventListener('keyup', ev => { + if (ev.key === 'Escape' && searchDialog.open) { + searchDialog.close(); + } + + if (ev.key === '/' && !searchDialog.open) { + searchDialog.showModal(); + } + }) +} else { + hideSearchBtn(); +} diff --git a/content/fsdocs-theme-set-dark.js b/content/fsdocs-theme-set-dark.js new file mode 100644 index 000000000..b6eeaba3f --- /dev/null +++ b/content/fsdocs-theme-set-dark.js @@ -0,0 +1,5 @@ +const prefersDark = window.matchMedia("@media (prefers-color-scheme: dark)").matches; +let currentTheme = localStorage.getItem('theme') ?? (prefersDark ? 'dark' : 'light'); +if (currentTheme === 'dark') { + window.document.documentElement.setAttribute("data-theme", 'dark'); +} diff --git a/content/fsdocs-theme-toggle.js b/content/fsdocs-theme-toggle.js new file mode 100644 index 000000000..5e32f9e3c --- /dev/null +++ b/content/fsdocs-theme-toggle.js @@ -0,0 +1,38 @@ +import {LitElement, html, css} from 'https://cdn.jsdelivr.net/gh/lit/dist@3/core/lit-core.min.js'; + +const prefersDark = window.matchMedia("@media (prefers-color-scheme: dark)").matches; +let currentTheme = localStorage.getItem('theme') ?? (prefersDark ? 'dark' : 'light'); + +export class ThemeToggle extends LitElement { + static properties = { + _theme: {state: true, type: String}, + }; + + constructor() { + super(); + this._theme = currentTheme; + } + + static styles = css` + :host { + cursor: pointer; + box-sizing: border-box; + transform: translateY(3px); + } + `; + + changeTheme() { + this._theme = this._theme === 'light' ? 'dark' : 'light'; + localStorage.setItem('theme', this._theme); + window.document.documentElement.setAttribute("data-theme", this._theme); + } + + render() { + const icon = this._theme === 'light' ? 'basil:moon-solid' : 'basil:sun-solid'; + return html` + + `; + } +} + +customElements.define('fsdocs-theme-toggle', ThemeToggle); diff --git a/content/fsdocs-theme.css b/content/fsdocs-theme.css new file mode 100644 index 000000000..cd0e6a975 --- /dev/null +++ b/content/fsdocs-theme.css @@ -0,0 +1 @@ +/* Override any variables here */ \ No newline at end of file diff --git a/content/fsdocs-theme.js b/content/fsdocs-theme.js new file mode 100644 index 000000000..eea7d521f --- /dev/null +++ b/content/fsdocs-theme.js @@ -0,0 +1,35 @@ +// Automatically scroll to the active aside menu item. +const mainMenu = document.getElementById('fsdocs-main-menu'); +function scrollToActiveItem(activeItem) { + const halfMainMenuHeight = mainMenu.offsetHeight / 2 + if(activeItem.offsetTop > halfMainMenuHeight){ + mainMenu.scrollTop = (activeItem.offsetTop - halfMainMenuHeight) - (activeItem.offsetHeight / 2); + } +} + +const activeItem = document.querySelector("aside .nav-item.active"); +if (activeItem && mainMenu) { + scrollToActiveItem(activeItem); +} + +function scrollToAndExpandSelectedMember() { + if (location.hash) { + const details = document.querySelector(`tr > td.fsdocs-member-usage:has(a[href='${location.hash}']) ~ td.fsdocs-member-xmldoc > details`); + details?.setAttribute('open', 'true'); + const header = document.querySelector(`a[href='${location.hash}']`); + header?.scrollIntoView({ behavior: 'instant'}); + } +} + +scrollToAndExpandSelectedMember(); +addEventListener('hashchange', scrollToAndExpandSelectedMember); + +if(location.pathname.startsWith('/reference/')) { + // Scroll to API Reference header + const navHeaders = document.querySelectorAll(".nav-header"); + for (const navHeader of navHeaders) { + if (navHeader.textContent && navHeader.textContent.trim() === 'API Reference') { + scrollToActiveItem(navHeader); + } + } +} \ No newline at end of file diff --git a/content/fsdocs-tips.js b/content/fsdocs-tips.js new file mode 100644 index 000000000..787e183f4 --- /dev/null +++ b/content/fsdocs-tips.js @@ -0,0 +1,59 @@ +let currentTip = null; +let currentTipElement = null; + +function hideTip(evt, name, unique) { + const el = document.getElementById(name); + el.style.display = "none"; + currentTip = null; +} + +function hideUsingEsc(e) { + hideTip(e, currentTipElement, currentTip); +} + +function showTip(evt, name, unique, owner) { + document.onkeydown = hideUsingEsc; + if (currentTip === unique) return; + currentTip = unique; + currentTipElement = name; + + const offset = 20; + let x = evt.clientX; + let y = evt.clientY + offset; + + const el = document.getElementById(name); + el.style.position = "absolute"; + el.style.display = "block"; + el.style.left = `${x}px`; + el.style.top = `${y}px`; + const maxWidth = document.documentElement.clientWidth - x - 16; + el.style.maxWidth = `${maxWidth}px`; + + const rect = el.getBoundingClientRect(); + // Move tooltip if it is out of sight + if(rect.bottom > window.innerHeight) { + y = y - el.clientHeight - offset; + el.style.top = `${y}px`; + } + + if (rect.right > window.innerWidth) { + x = y - el.clientWidth - offset; + el.style.left = `${x}px`; + const maxWidth = document.documentElement.clientWidth - x - 16; + el.style.maxWidth = `${maxWidth}px`; + } +} + +function Clipboard_CopyTo(value) { + const tempInput = document.createElement("input"); + tempInput.value = value; + document.body.appendChild(tempInput); + tempInput.select(); + document.execCommand("copy"); + document.body.removeChild(tempInput); +} + +window.showTip = showTip; +window.hideTip = hideTip; +// Used by API documentation +window.Clipboard_CopyTo = Clipboard_CopyTo; \ No newline at end of file diff --git a/content/img/github-pages-settings.png b/content/img/github-pages-settings.png new file mode 100644 index 0000000000000000000000000000000000000000..a7657705daa724182a7158891b44660fd41f9a39 GIT binary patch literal 33534 zcmeFYcT|(#*Dr_#QE4h7B0_A4f`Ed6)PMyYv!(X=a0z~7I2=j&)#S6eRlag5n7rmtY@#BWnf@n zRek>SB?H4r2m`~hzSF1ZBikx{DEhCH4oVtI3=9=9%w#J@`u}HMKR5DZU|{=s^mB~! z&WpG7!3$o`483%~_FleL9(D{W9(Hzap0B`O=6a{;w*&{PK2_57GvAt~q;QTjV@PBt zYPjrcmT{Z8zWG?sXP6n2?fnd!XkReSbSbT*Ji#>L{JE)YlhX>vZzrRamry+MDzx?~_VSEz!*J*8O;b6dDr@v=hLbCtY-P*dE zALqjV>+U;(`OmOV{{3+6i%CN_2s!_L_?^gZ$Ma;Zzn;HT{eMBe#QZ#&Y~OX3Th=kH zAZ4s2S(@!H@)z}t%y#Ei_HMe~#`-%^f8J;Kjj@YT`)dNvk}Ohg5eAXb%)X}M3t`j1 zg)^QbF+9|H3m{wg-`8m`8N@IFWrp41-fOWcG~YdFQ>OHk-ZMC~#wE$2WA+{`sMC`B z{_AqnLw0!A?@aCm@0u2}I`uWCS8ORXrZQaTFShpM*9Yf1rbqM2b_cCuN{i7AI6VcK z&B0c)bBPk>h0$)YOyMlaLSR3wJS*<5)RX}9)!kk5 z4xhs%+U0vv^37(NlkR^>@=Jit{wr*5NJjBFm2g?&I&9I^yus`A*ZiHbvx0_T`MW1h z&D>M-bzl+7HMY1~^bH^+)I2A!A^-PcwrI_A-^Z%@3)v|8CN(yrLS?rj`GPoOAwR09 zCW!p-HFun|d=xMycpoXg8*_pQr4a*8vazsdG4S3L?e9#axhK`LZl=-P;pF9J@ns5} zkKK)x*||q;*Qq_QBon=qLd0~ynf6@#RkwA^Fs8L;lJbyr(_CuHE}%VZZ^YYUMQwNW zd1FspOt&-2OHslQa+vHoHY2gS3S>_a+J6(yk^&>k!sGs0DDR#9Oi!>YhA!Vw>Fu*w zw&e@J&56**ZiZ_zH#PdF-F~JVGnf%Uyzy7L#~^b!n&2_?Bgf+afr%Z>g>^ZLD|f!V ze$eHtGJ@r>=N4n0wS!&xKmoSf-Ij zzEW2u%TSFYLb8Oz4u9F7j(CwFEA9Il&LLS;Nu!1_4XC*$b!~8SZpAY&N$Xuv(%efpPPYnzo|R?p?;{{;9lf_9a9w*_IgtGPu350^$9 zDm`$P+}J9K-|MA>dIL%jj#+xyK;=Hf_au-y0(2u(q+lekgDPi1kje*j8ZL`3CpMZv ze@Sa3iP+cuK%R@dYO(tJSPYx5S8Oh=Xclz^#6Gr^b*R(F2`mu>3bHFu;+tx_sEMQ@ zcvliJRbgAdG^}EM|Fl0gbgR;UNg)u9>NZjfao8E3KXJ-jAf|;J_mE=OSZ&{8V1)H_ z!@N9526w8*(1*GCzCv7?4`p{LX3_RhANR!JpWNL9=;>g(Dn`fN zjR8MA7Q+p(4ks@Q;FF8Gc!CdfFnX8C-^Yk4zqTb&O)nt3ShdPMiJ+n}t;40p00Lc@ zP0o9I9zz6&#ghJzwZ9iuxSOac$+p3@H=U8U zFC=<*g#gTmg@A+C4!$)Y$cx!-?<(@ab>x0mI{A(!V{~!9FBvHV3 z1_Ehx$@`S~uy=UUfMz>;6oxS{DEhAB=T<&02&m8P;esu~kHtdR|2e@hU1Smr;N7fy z-4QC^cS0QY(121m57?soB6Bee@JOgl|3He(MeF^xpFNWQfUmARVK67Uu|zFgj)*|d z%(#WOhc~WwZ&_&6tUrAU`{bv`CH!sdmGfnR6He({LJajDIZyDerXms?%H5q-gT901 z&dS}ZXJWb{YZ~*mf_cYQ6V1GD+KvAxvYnjtA(^Mv_Mcg{Xg`P`L5ll)t?9neC##_0 zh4PGoUb4%SC~pPi#L+zT^jINNu4Y6*055*EyP-tQVkx(kPkxF~$!Ni@N`R#+0pR`e zVN1?WjsiYK?1@Dk70>2R?5$Zj9@9}b?Qp$HW>UYJVJsGrCxMwvc?DL{>Mg!zK0o47 zb1Q<}j-;O9eS=Vnq|2tDBR~0waS>y^5CHF@ZRjJJsX+tUE%4s&{|qIRVFS4KxB2IS z0oS0$2B7$Pne5AAFV@eRX8xY2wU87}6IAP_5CBH}3m+Np)w4jBpC<$fcv-`XFUt;B zLl=Ke<28x= zhLGo%Z{5Ahml69^K%MA)ktOw-!1;?3Be#>6dei5aI^&od?FRRWq$fd4SF164%*dF0 zGs#aQtqD1DM+9DYn_w48*9UWA*aELo;LO2ir?2R1DPtEjUz0g*P|V3b_j&Pk9H)KT zVz|#?%WicWhOvRC$S;_rxs}e-d0@^o0VG(hH`+fn8v`qy{b_@d?POFiT7q(!d0`hG zV;)<*$eG`n%eOg@DM)|)g>*07vRFX?{o#6$FLIcRh*>E|%9NqSUrw1FHCC+ulRtXnS zk;&qlY3?s`;U>Mh++aRkvq$4cZZ_ZrTy9GGFx%cY2_%LaJgbo)e6zZO{Pr0PXB)+F zhmZU@q3DKye!(>XPG$Et_E?bi{mS_pA`8zMfziyd90pgzOtCsjdJ=?s{3&k#h1SaX zw?Sw}^bOD6Eif?lne1jDKPNjxhG*sTIhXO`_WSBiCbBA*>`aY@D+bL≪zkbrk9J zl3LqEQi2?|()GjB5dNA8rHco95mL4dY(Zh)AAEX8AMc-9;a`3^po$Bd_)6163KRDhCi$|W6x4x zqZg1d^4ITPyqXt$wYhkB>+(sUBDK!)>wxb^X7LM21hRz}R(vyTb)}yBW4q~Vt?Dx87gU$oaD~_63POJG~>LeW2NO~o2fpE z?A~WbMQ(K!If+d=kOckJUaMEkbwGdkyqipXGddXR*k9n=-Ymr*d#kYWOD5Gm_?`6cL_f>dFJ^*a)^PXw+88r~TUU4WE|IHC z*oZE~BJPwyucqrm`%Pqsa~5FA-eBm}Z0Eq|5g2|#(T>S*LdNGFdvM`9sm}PAt#mq> zAN;>>BH0-h+e$<6`HdZ=@uSxLo@?I7m;i(_0{F1mr8m?#G#K_S_w3A{Wxhny(IhQp zJ0vJ)e^6$Yh3_8kh7{K+)(8ljg63?kLs?J6etrNnnbJkAgy!5c*@%2#PkmM<^N)2i z(8=ij`Ke?iE_s?YY?@GBJQ3&4*&V9s7({unm#}EZ1QcPpdr@EaI$;p#?zZgSvFrD0 zsYGXfPNf9n%4}y~?cEAf9@`S}=G6V}Y(W0>U6t%K{!UNKe|*3To7?VGID+VtFjSsF zh;RUDT&lr>ej?3#Vy9pEg z9O<&iRyjvzP|Op#n#jr?#d4g<>`7QYv==q3#cc*asDFD+-%KRA@3oe43rOrOcjCBb zN_6y2Ll%G1&8^ur9dg>e_s!mhp-mWTa-4WF>dTjYLP3f|jnrpvUU9qVd%w3DdrLQB zdS~J?UC#2w-UwVkB;p$Rf2z4|Dn^ zZ_G1Fj+}-(tog)RlkgL!1n}v-liE^jBqNfz^LmAux3X-$;+otbrofvQc(j+9a_g9e zB4b8J@2GwI6u;3^3x;q2b}Xbmu}rcoT4$wHt1s^du@!&_>{DSCz~OaEVy z?>ybj5;I5niQICGkh@3Mbe^Y2I>T6u319{N};@aVoN$0G;tDt{-lYh}}G zJB9Ut3D^ZACLKxUTKH*t`LKS0?+dToTVvYUR4RY@s#Whl&fktkK8ha(e2<9j=I>>@ znBYIFHyY741JB_v6758e?(aXk|LEfpId|lh=tKGcXG4OQ$X7{!Zavf16=6QQns~GH z|87e0R_qOKZRJ0+{QZP(j{h&@AO&t`A#9!9YeTl1@@jc&JpTlBbjAX74^9FDuPkP* z^>-%><#%}kCJ&AnrVBK;fuAt3_eVW-xBJ-PV$y^d{?J|;Jo_*4DfSmYuzS6HMq;kD z#bk9#5H@CaPJVw^)8YPeSyGp>(fz&aM@2^U3~Hc%{!KpwrTJ7Up&`uYau>q=%XSy-AWJ! z({n57nY&Z+;&wZv{3YG+5=3e8-Gp^J=lo_tfu<{WtV`!A=CwLc0>$lAKVN9e1UBi6 zie`!)s0TcURP1|UXSz;QdiU<_X0yFDp9IewMu^w z2zbh{dI~H$Bb1`?!NAq?{^lx?;xSSDp)R=M>vHl1l{ABPAbZOF_n zZrH-}6F+ay02@Ff3JVV!fW!mplssk9Hx&b}0hu;nup;9M0!CioRRWnG6P!Op=JKSzQ8_E}EeYE%Vd=kk^teyV-H;7+CNJREU=tRF!fn*vm?9q(u}Gb{MJ!#8#F)ByB+0C|zv)~X?}!q*2;1cwS2ksxq;C@{_qB4{&uC zxMrm?8KO#?GlE}#AP2#&v9%;@c^-R#k4T9-s}+yZiFb{zSO}z-H(T*cTN-@DDOIl4 zl;rqL41s`*cssl7hsayW{0x&f!mhwB-n-chd|#G8S*9l?vVpE2U@kR9lnz)7f|Ud1 zz9(4M|9z~+?X#{v^vce0IW86{7qr0I*FHaBSRahaz2KiymoO zKg+6CJHZw+c_9jr@sYHp5A7&@8qrde@X{dQ`+oBqtp=cI|2l~4^|$k^wz$Cpbd zyWGlVM-3ZU<)bpq;Z>IDa@2Pw1t**Z+{+yZOb$j&P61b{#CA@+fI)wxc#B;GUc2Xh zKXXu7zB$!l`JHV$`AwIj*vk3hbZ8|<*X8B@n?)dsWU6}=Iz>iHGqM*AR`Cg>93Cy= z?W$?_)UCa5YGCJP7I^8}mbGTB*r?RrNtw}>3ncZIE<7pYzzi|`M_s6`rp_Dx3h!RS z@RzO3uB7MIhXs=D`JxjCd6R}(KC(7JhAuqDd3YpFPSDhCRC2hrx2}!UpbJcN34Gku zvV%4*oCbb`RddC2lWp-1axR0eBL-hCch#oV9>U)Jp?pr90EbP(DRU~KvMjEq&|8xk zg9f3snI=B`NRUVKAFGd|xq$ef{8h=iH5xHk;WAvY1-36|zS4OI!P?b| zx`e|;ZwVSI`|x-J(|3N_Ibg(hw)Ee?9^f_%Wh2$o^FC2-i~v%HZl$Db=f4J`J}cA$ zlCNz0kqoqEc5Nu%4=HBKvnlAX#NVV>KD0K@S*E06y0}ZJvZKDWJ=i}a%>u}s37=>E zH)~C0AvuniD~qmNP#J^yre=zWGyt^50YNi$6}gai$kd0phoSg-mj(bC9aV|mTuylP z@e;b9W1%gK@vN)t7>0|3ysFSUBl??SnY>cwYfah5>SA*bP7H+|r=%Iqz6R{UwXM_n z4?=pD+DD}VCrT|460OWopSLZ+^mx7d<)cSy5=aoY0ohhqNpF)&`ov%=`WSx^di`0QZelf0biVZUzB$@OyhQ zvae+tTH2TcD$Dr9$S0)seZ3g;=ibsK{exO=IaR!({Iwv&vP_&DvNt?SRjM_!_tG+2 zw=`xK9e~L8fML=FcYUm3GOO^7O|W4z`B#L}tz4kZo;tjX*D_^N5`y5gW&6{Sr)m0< zlCcT@CBwKN5SH@jKKr*FQY}I353Y_{?KIuIg8h{YUQW0yRSUSilIJ%hKzcAEMXlyW zi(O<9s*`GtHfbOOoRnx=!Q7s3~3TKeINGrvzqJXh96 zsY3XMH*kIdhIBKK59)Ft|N1uAO4&)+SQi>(zw1QkFMW=Ys-R5u4%Le8bKhy&`V++2 zBXC935HsGA;PP=B$kmru=QEKKh5&tK41!g#w`G;-uI?34`v`r)LWDuo-34yon$O0; z2*M!3ssSMiXCFO9yg*;A@6XS5)}d2_cOS>te)tmwxEh|wL%t(v`5^=*aRm+xZKuYwX=?#gL=$N)$@Tfwp|QQ9Y)!g- z(BVhx(H2;oX|QuSF|D#T-{mvWedXI|vn3+E)?u^1jo9*vXTRwJnm=b%A?*R?Ydp#F zoxg7F6oHy>6{sKz4r+CUO*7fmOs9j*O892chzqT~zTWqA?+m-un0Z~Br+cQ3C9^fF z4mIJ9?oALPlbe)LrVF(F08Kf`**h!TA9nKvj{EzfL385xib;u%i&+SS4LZ?1{K&`* zJ3quoyuQQx2Lo!5PjT3MQo;X=DB5Da%nh8s4^FprtFmnR9uz@Qi^A|Nn!2Q?NeZ;c zdP6zL*`h~HN!{;;9}=OVY?a#47X&n>J2Ou%g~?2;;VAxe81Vw10riVt!eK#?P&P+!2ZhA|@zsefd0RLJ73k6*zd;@{aCkwRG1dOQ{!$ zw?t$GaBE+%yEHZ5{nJR$UCGs*17BiMVIiD709_bfJJ?p!JRxV(HVc0VCtN!qYGOHp zT147L3KV^>6OO$V`xU~zZoO`C2~gX7gaONLJSxr{eHJg$LzknEqUQhOA$rr`@D)a2 z_eYO_-R4)vXB%sbh-6nV7_M_v8K+Z|)s-N)=k(EAn!44vM>5y`)fQGfptrDcLo#3D z9tD_cgexYQ9vjw`H9W~D-Hn%aB3KqQerAr0E{@-6OV-xwed$}VwPoeXx?uZ* zx9Dqc%Mo~uUV0zmXNP#r>2z@_$`H7r9gnzY2i#_NYUn*SulvIvLtuQYNrkOAe|zW& z%235Z{^CNvLJB*OsID-+clSThRzcOc2h9q#V;uzlBUpg&VZ&uEvaPxMmoj|4P4w`z z5>`j!B=EbWuiC5Y0fyiv-s-)Ly=6dX@)OtHrHQgdG#F9y-sSEr+q&HF5m)w7Vgzdy92%;Jc42yi+|qaRGkYSI5m9>Ug(lc7u+Ypd zJcgbX;~IAkL$B-E%L=-dWx{k166)g(O{pku<$kq9+ z;n){xPh+hgvjabz4pTusIp_Bj`H}g7DMK9HN@>@sKQQqIqz;lV?19X7hHCK28*XSG zW>2}LzJ72*>g|BchCeFoqP65-IFa!#(+*px3m8v4<-e?OK=ln{4#GhLd4ksRsfZ)W z47+N8y_K!nvcgk9;wXz5@#!|bqrKUP^n8O0ERFBS4Px}JlHVH?-kObJx?3>tcrWCm z;RmZjtEZzSMgdoNyy}XKA|q;Yo?>+>n zC6u(eLBlT(s0?)>T25Z1Q&xnm*-)Fz_H{<)ROqdxfk6TAwn4*GmuaQKBq@Ts)LWRa zbAl1rgnbh3$8di4XJpS@JG;17r&Z|()kIc>$`F`kJ(aM;2+Tv97-5In4(~R=roEnp zz>cH(W;8Xwn0=F10_IIdPIVQwg8Y;RO$U^71)oYJt%fx zPbr`&5;`Kpa^36I1C`NV!J&TNW6ugdZ&V;V-+d@$Nafgca`8c&FELQj0Q?O`IHGlpw(GMwD@=!DtqTa@2Fs?; zWKqj_`Vq&!f3`iHW8om*dYgq^{X+sDAGr@I%(>ok7w(|zT+ znZ03Nx4MC2pb!hB+GBZaE+(NaSYQ*-I5oWMLeQ}!enEnYG2*qX18PV9l!1YA0tw=* z`_W;>{a)?v&F9BsAJfxny1B8R1nPZh1@MyV!W9=@(w$xRQNI1J6P?__fb6UEVm4g| zXmlU}1LfR5-fjSRRM-bT{r80o1ML6uesn7A47ex%%WsL@qAUC2(20`Dl?6&ADK}`C zUvQchAiKIXs3%_`Tr}9Xt^6PJBgRVsS5I&JO5u9xU47H6L`7C--yJofTLWu}E!@}0 zf9Z`Qj1{amVOz0g-dE~zlc)gpggk#wkAQ-J@v{;^MYOFFUC z8yG0b%4_R?Syl$EKL?1q`yE<=+LYD*?)Hc=&!~%YLO!y*Ow3F=%c)kD` z+23b8EZl3#$QAKl+j_mcY2dMF*f^oEw7%wAkdl+4=O`O^_8$e%JKP0UzG!E^dhh1C z4_Yd5n%Qpg2aj#s!D!w+9)idV4E*5u&+%m4Tl&a@%rul}j)InM{*Q>!v z{CwnF=wTh>G0mi%G10`^B$>QVb1PL+3JKakFug?RyfqxHU%x>G*=k6PIv5m@r{7a{ z(INPnov1hEUNBR9=gLW7#0`4=@R(K*QIa>v`-6gizf48Gi0c|wpe`UEM^hSFSSQ_CyRud$lT_;?mFW8P#Sl75aI5?wl5HiH%w5@`S-l6(6L4#)VCb@05oRT_NF zfn`%QJ8HqOr{~FZ>-pXSQgDvLF9?W(mJ4RI1vE1y(FGUfqxqzq`Q){iYO4hPHJut! z8V9%&cRj@J&6CE?cS~aSb9ao~f3P__C-UnkcX>Mz-oAUX)PUwokN`A3|86!ql{15| zNvfXko#K3IZyw2fZ?uV6{>caReEn52KZjfFyo@EcA01^;(>7(j%p{L|)8v7YYqS{c zDc|A|Gi~qjdt%Hy)t$rwG9FX7ZBxqav@ErGrKS&nKK39&2+}0!-6W$&p@fVlX(Izm zX~SonLrjzheABHBTKzP?E1V|zm$M++qMS+NCGfFidJIrZc`PY9BWmy+A)4M~u`C76 zJC&8pS>?65F!INT=cK>HM(kBRRFOn0da){sX>qx09n*Nw{W;IoW1XityKE_h3*Ti& zUvqY{ZTa4Jx$JL&xUI4+o_A$4M0E|QqGXZ#8OUk+!QdrDc{?*?k%f|r%MVb=)JCg- z^XZ|H(a?cy(okPk;>O&{IF|q&jp$*-Rg`8yEm2eMdh5LMe7ZPC>`Se5-Q;?gDB4}o60rCaIdSc5*yOI z?I9IHZ~A;XTlj5;Hy%`4!>^P*slgsKoAql}h?bMJyePZfb2Y`G69?bhf?;%Hc<<&w zadVU%6luJ|m&}jueRYQ33te+btatLi`EzN)yP{v&NpFFT$1kL3+D}U+dNY~xTM4}j ztq*)Srq)|&?$(6>6!ehPT7l@Ms*k|56n z>Rjdm#-T<6kt0thko^Twu#+gU`PjX@;(}=*C>+PU=cL^_SPq%>yP;RslvJ8R%azxQ zX~FszCX<(*7D5h|xe5Z@rsH%ejvcAG%|!jcLUSUDtH8KI+6=S#D6>$-Tp_uTGl2NC z`L~~#8B`&yut4;i^IAJzw;9`Bp-VZW=oCy+)>3tQjUkWpjL=)`=;(YWrPdr>O2A%( zZppOQJv|ejOwADsg-5A{6GAaxov0gI1p$F$UAnGQkQ;i9Y|uij&Kl&y8K9Yy}Qo&p1=3YUGGR{$R!m6-JsF({`WH5 zlBK(D`;|!0W^xI~E}Cg1Fb0sEi_ff^%jpxDJChnNgGo4S41V}wE}VWaDf-?dtnoa< z4oT3R^8mZv0Sd_bXEQAyto{z+wZxq91anD=_N6FZk=9|aBhY|aT1et|T`Wh_ z=pINPzx&6v0&c}RgfZi{u`d>S{n4;uPGuseH6yOl8qwT~k{9a2KhYT z$=@Dw2so)UXmL=6ep$qAI{U; z7pt=w3A;A#n8Io^@^CwnYs-==7_jobnYTMkATJm;7YXCB9mKP(4Zsycm!?A&yIfFo zga(@M`ID|IU)8;hV{-h#up`)AO~9nR=h92BP|)kP{?5?eh+6OG4uY04cZA#qgAiJ2 zxGgtcq62=xb!%sCB{la8jLr7VUT6;j)O>)8BZQ>0l8Vf_!e!8oxF?ys!GNQKVLFQ5 za=M5Fjr|kc3{N9t0#`k8pJ2*H*1@R-m0dGz_HHFt{6f^hCN@Mz>SUqI!RiPFz(8c{N1!kqBzsL>r2J9PTntHZ)1wuq#ai zq0dm%GXpsEz3&pVjZ;49QY1BdTM=75)HmcZox+cfMIgj_A`f; zfq}T!D~%(88!@QCT8`aGW>T*>B$!D`AZy14S|hZtwE}1FT*Bw{u_4)yjVY_ zBDidpt>wCe)H+tBWZ`GF@B_P(K#$cAa<36=P<%Jk$R5_=xy^i7Luo4$%96Rj2+({P%p%{zW?GM;9>A&u=W!1|KLV(i(= zzT%tZG~Aj3>o>__fquT1{!`}@;i6F7DWiVE-CNWmvz&zRB@xV#UVxhZ*&@E4RU0;ywEfvhfw2 z1%1S6NJAJsSt4E!2IyKaB4Z9mO6m3r477u8{!i0dTrC%H{w%^pq^D9s(8^$#r!ed8 zkWg5+FhX{&8EQH@Ev0*Ey1^8GxS((BGXo4N_&q0J7FAOyZ_vX}*omCW4?K#vxKBg0 zf|5*kbhv|Ie*Y1vWu1kP2RfP!9^I0;huT(uFNc>byU*g}7%NNl`A+uAYyOi@kvH-? z(Ac#YeiTxAS!Aq#@?OU@ zRu}GABl{=BJvLjHc5~^{iGegeiRP6T5$K;htS4f}JW8%mhh{euM{~oMC`sbB^JrxG z9fGu|06GS>QH9&M;&0ZwGJZy)FXF%!{~>3$xiJ|<67H~@-H`C0a2lW%z1v_7Sf$^! zX1)Fkn!EXZ)}HwO|_ zi7SI9v7L`b6?Q$b8(8%AD7LAR+l9}j>=ZQ%ImE*Q)=Y}G8#G&dLtEsXzucSR`()yd z9r9Q9DJhOKp_+%wv@RucJKI^%F$Y+gT=I{?k9s9@Dqz6$LDy>)IwJpsjQl#YEApj~lk7!Dig}41wLOlKZwAG$QcS?@ zcYU*syY$D*Ixk!G&X*fvJq`7Rzo)bZ$-I)jwqZ}E0~=QcWH`vCvNk1~PLsEz!khfp zC(T8x3@}NfxgB{m1?CXrdxX?{0E4{tGNRc)vgkMP0c}VqynFvZlpX!M&ZBe~47!)g z{FidlnR^=GeIz4u*!d}u{Z1IDBb*-aE>s?_0Z_AM1s%=CR5!1vduUEmJ31VESZ)?d z)jXWt7dC_fHAeYEU_q>6kYBH>)c1-^nW;ya$h!CT(3st1uMAlm^+uAQSC-ItWif6L zDeSO3*0!A`R2Gif4xsaY)ImO~I|R+H4e{i9>k3 zB@rKDr3Adw?jw4Oc~;Zk?e|N^%Cd$+N0Maf9)YsEit7@ynLJrf!ly6ROCO*-K|sNN zibwKrU)Bu`OtW1_X%?IdBb-aqL`51Q`^(29(eMoRl(Z95+1*>=S+o808V!i^qb5z|%iDoreDEJ|W^B`5mF|)6Zt;*6aG|B5)Q3nmz=o+JV zu)%6|Ot0a;94*XkR09d>=o0;kpLgG#TZG0PR$-C^wh=niB>>I0pq><7iH(DG>%?fp ztt|H@PKa+OckpH20m=KryfS30^0%))3x<8p<*_?OUym))8vzvM4_Iq@t6SEA-d zMA`FRs1lT^dky7jU?thLou~NX#TGC{?qeyZAx$P(!PGOvKlSV(71gagS(^J@7E~Nl zJ5;-)#-oP#fum3Z9K_Bs;7M2QeZ*}>Qye`Bmm}<2X z)PtGT+Qf@Pq4<0~4EO^aUNFO|qo@Ctkzuu$4q;OMM@vE6np@L%nC%rVUY(lWi|z5V zLu9~PyY1Lsh_=1UktX!YJlJT|3?ir)9nQFu&MF$%u7Df2Ir10Q=JWbsN+t_s{HZH}5=d1P>hkx}M4XIpi3os)8d}%~Tw?OH5 zI-sT|ney!0ZH@3~8M;trRFnck6a@&f+|h?Y$pLOLe-51e4aj~QnTcdy)JgG)1!asQe9UJoM_xtMLRkkzOLyhEs^`trGXu)e3q4Q=(4|T@Y``>=g*sZhg8|@ zmTQ=Mkmt7*NTt|x3B@sba$(c5H#Kq&Ql4YpQPyyW4oX*Z-F$HoXnFc^_UiftGo{$` z%-28p-MPpzbWCM8GO>7vT%J21Ccdn9pZtO8qOrZ7_MGH*e}tdqx#3Y^%x-}D0+ z!FZ9;jsHd1m5FznJ97eO6{nzEfvKn-KZF{6BZISvPC*l#vOZsz@Z?JoSnf|@RMYPy z=aqH-F`(W9QRwdw__Uom>=mL}{e-P-q;!{YiNwyziL2IgZzh@cXVgsf~wWUn(CXedu)fC@kd0`IB8LH^~FM%tI zyuM7o>rYfd=3P?1(=hX`{iyi1nu@vnBcSes5e>MpkJtFIEFD=MTl@+9r7Ds=Dp(k= zI36a7m>syLv#ry*ohpoY-MX0ZrZPt%fYz3`Yxyqw+fsjjcStR(O@84aWj`Z8>e1O58vyTFAiJ7yU5=TpY@Ymts-S5Ck2X}T=3b9 z`$CuvWsp872 z<2nt?O(1RhpCp^aKID}ozysRAsvce+=7Cl1O|?qz0e-9JTG{WAcdF?di&X!5M6$MD zYJhpyPGu`Q?>WM;r#Cw9=Y&GOY507=qAV1Ife3KC-2ElK!>!+3OR07ni(G0_oy?-( zcstgOr3t$-6m!u`Z2mIkg_9Fs+{(JsV&1H1rH%?2GVo<=%^No+%mVScyclX$(Q@xH zdDYcS`H?lA8!SfxXRYP_DklgVAjxA~r+clhYu}ln-M&^y)9=79{6fg@EKRPx+&jg9 z<6r5wxNqQiRbe#QUkqe6=|mxyPbdV)Cj9}Uve=-4jt-z3gu6e14C;;7WRv?6E7zR{`a>W`Q+PvL8q4 z`la%-c)Y0C>yFY~oAyXofZ?S!Bgk#3s|rqYPL11Ep+rF!3(^h^@AHekO& zU!PC+ge%q)6jbH7BHIAMaq2p=7f@wx745%Sabeq`K2v&JNYbFM zGXXLhQFZ3>X30~Icy?d5;B2h^O&arqS*f#&-Xu0l`*OoC-O2 znUf8o3tPnqpt*KpZ>$d8dHo^qaOqV2h66ATFoOf_rt>2b1Yl5Ydj)XhSHw}{OQKdAx(wbQWWxaM&B%bt&HnjDD%ZwqL^L-IPh`Ea6 z4B4X6p3BA3j$;PY*XXf4QQpbbt?aVwLG&{)%%k45Ab(_Ub(`V&Y}ja$5B_2>?1rYR zzvNkym-x;9lB@N?d8k=N&c0_ zdr{67R*RB;u0_`5k4u&dFqtFL#wu!$Qw(NW$U$9Nxv0qL%3)WW zuPNTQ)`v{s@;D#>x=LsmnlQqcP+ULaj7Jm&xTW@FR4LjI_s|_G^#$Fz3X76S;*~h~ z-V#b&Z6o_lV& z+9hozn6u>5T!%##E5sh*-b8Kv^1DO5uA&$9T33&xAxvV9Lo0p zAJ$zWin>)os9QC%7TK4nBuPxll5CMZgA}sNOt%)dC9;PYAv1xkdSqZA-lm? zXU440HM)P_=kq&$fBc@~c)rK)kLP&&<(N6oxz6jl-sgF~m)Glc&VPp)+W+duPdWQ! zEEPe6D_53%fW2YVHgc=lb7(m!C3c{nZBtzuHftY1d*nNRbHdF9zD}y~zJI}##p;~2 zLQVH{*|%bv z+4%xrQYB<%DywP>$6BwvUq#E~^+o2oz2BZAP*R3nD0)k^f)2MToD1%T+v5JjgcQwY z%vv61zPs(#s;;%&!>ct|IKP-5f0LFe182LNfrYhv@0BkuZgDPp$ z4cO7QHyW&5U3Id}&LG(#1>v|J)l{(@w9(&hxDgGKig)~;d0HpPLVhdKCz3R(e;&C* z{lcN<3yka9TRxcpVlcf(;3WV{Vb-DTK7+ShmV)EBh+Wwe_S>e)iXr`bw9{!Sl5Ljg)TS z@(U5?%n(*q=@HlDj{$kQXSupX^N)KCHfAJHfCKr@d)69N#gO`nRmEAT)q^|z1$oev0y7ItY_ z0OgCDB;aP9fL7UvQ~&K<^qC8)I~2Sxpb!B31?R=>Y*!+(o@&vw5bW^xjN-d3x{PB0 zS1T@sz1l~-qPGYjZZvRQw9Z?{e*qEgt#M{p{xI37r9&UF(IHE6?;mzTjBy{-8C-nQ zWvRu7aM&^ubc_%DQvayoc78w6SkDl|fod^~xYxXVS(-Gz;w4>{GigM;A0O}w!0`l} zFDdY0EHUX#I}w*Tjy%nFSv$K(0Os|Y2%9|3aB^aI2$wqNgpney7hrA6s= zH@|6*0{xZ_?Fu*CkO4GSFePPzJ^-S6s%F8)gE<)r@XgJb$LFJ#Aiu{!QnO}S9Az@WakzA#EcpfjH_X~u zzW@}5U+QkchiJeprT)GpOFdfsyKm|4P2Ouy7}5TpnuC5pRGv&e*y-ezKGX40witYj zJBU+dc%SX!ysb<2LU3*LR}rVRfpeVoWo#FO?d0JnKa!03);-9`U9?4iRSmL}u`YH3 z)KxO8>YU;Mni{Kmwy(_DXreTc0nbMLC9W{ce2}96r&?$(=e|yxYC)x3>tXRsiYa{ z?KR?y%h=alux&*0w9T|HY&>RDQ1ZtmeMM`blX4KI zRzvta&R+RznRfTZ*53K5IUzOd0o2zc8q9@|;LC@Qv;^^0Ua*nb$dn`n`yV&eGuf#( zzC&P{^XHc2ng(7{NJyLZNw78Ahk05*IseHds2IBf$P6(dj$1z4Ax3bgPKeb7X43LK z{kw4gk8t02%$X0?Gctgh*^=77FPhOyTVKkh+Zsmb^m-GNjf85u)-{^t;oU@o7g)k2 z@>t0;raXK#*ifj@b9>7P2zl@NPY$N}C#J80wkI}U$VN5f{r)MO7}<N1jL7F0har-ps zOPM!GFET?_=53nkc0=9eiE6gnEB6_$p=|>jA~4eMSJ7uTR1Igdx&3%N0UeW&pxUku z5F1?I#gw!5YaHs83Na5n*(08sQ`lm~ZS=ebeiRUeOP>EdDy~3Wa`f;2fz%>rWghwR zLmXS@Jjo?GN48jl3s~bhrMSCBwe8af)Q^nkTb8i*$8#j#oXI1W4cP1GoPkiv2Fht7=cjLV7?I^ii%i zzV2qqPe2o)?J3VCrQ>53dt2k;CJW{zfjTRwYpYhYngIN=UlF%tQ!l`Kg6{>@NMRgG zECjeM(yfr*yDOtV>LR8w z_+T>0C-l}(*tloJeFq&pS}DnM*zu!-aEjA#OhS4s-^z{0ZY`KYsZJp+2Cs25V~YJD z*;SJT{o5pu809D3NgBd1Q2Zlc@fv&`#g4*n1<0Z~l|NSZ;m>TK&Yx&;@;uVL;HKIOB}WHuObErh93k z6(N6w;idD&{@r~IgE)*waZJ6Nhj+8K%8&_l3M1L*+7n|Qs8^m4FS6u1e_kiO-$J6) zvFR5>0eEioU1p~Bbs(KzVUrRgDc9CfE@1Z4fFQzrTI^|5yd#8##g>ka$l}pH@oKdX zU1-}H@2EHdc=rY>VZFA*B{A5l&p!>`oUXp}{x8*u6KS?OX622r58gkfee6L2m_>-Pkp89N-fNT0B*l5hIew)lFo;BL?6{QwoDK-$l` zM+N(>o03GBmr#kvx=KRz%TxOrn&q41gKz1mrUV5>|6JhtHKB1PM%|kjV}XOX?QLB0 zxv+U&jA_vTSNdlYUz!OpW4!d~X(mdW{Pa7`)&sJRqty3+{>se8-+=ziluWuxIMR>B zeEwCt?&i4?_6hTOH^19f%rybAH54g_-KVsiV%T605I%uAyqLnnlw}OrBeUOv@uIth zd{4)?nT#1M%NRrcN%%3UX>@(zF=r{Hbw7Bo?^|ASN9bt+U;3ET_!6++{g~gKl*?U+ zr@UW|+f;kR-onnxiCu8X>n1EA=YkB@a?NIXj5$J#v7is;bH%gC$CxexV-gt?`@v5n zR!FyZ0alD$%c*03mC1J$J_dE|C(C8Lh0y}Kcs_gv1cOxWypguon|@SmK0Q%+Gj_CF zW&syp^|{yjeXNGdYaz|gJm)2u`*7)JP*TFm$VkuPLF@7ERC`Lm;e|5*i*~-^?_8Jm zJ&gMYIwTT>pc7%Yn!)$HCT^9!UonBHng2*&RsC|SEmuY7?LCiopSErYZS!8sMcbPA zs|E5|pKr&g?Uvc3xG<6W@nh$TM5X{NW*=rvcUf=vBb{3f)LHm?&?jm^x6W2wAwxNu zD}JF7SJV5}_!hFy4D@XOt)J?f^toB5!$QQNcM)75?3!TvA2B~8L;S8fJR2|H4>tTP_$0wmj<%ST zA1u@JOO%|50e`jdfK_>s3U*{SFV&ejZ0 zz@p$u2Lx{J2ls6D7$hY2uJrXL8SClRhff;Cl@vhuZlZm+D(>t7RwwuHuucz&r;YFOSblhVClwaLPqV>juU7oeSb(Nme4e2_riaip5sNMUQs5EmS!kxr( z3tEss_)$9vl5g4v43hYJ{{s=aB6J`FU}^m|xiqvke2##=&-q!$-tlGJU68Qu8poF> zq>BmjftHf@gZs}n&hcX3s`+1Kf(DF+zZ(;alRs9Q&!r>xA#P+kMI4_%uYjLitN#<2w1x>?S zPJ$9U9nR)TSApZo=b9HNCEZ(z)^v>`0BIA&UZj;+NL0bU>yc8w)(pAkS~!xBInrn4 z^-bCpEf2tF05D}5a$5TQz;Q!N81!Dgv~J7o^v_4+55a%Zz>QaXg5E3ik?`4cMN$;k ziQMu6ssOi@Li@`gUvmK|7_)aW5`mpa!k-ICutRZO?;eHAJG{16H9M|WEJBL8{IO}$ z=U7|z}v%WrCR39XoN0F9$S?qY>_-^MEWhGCcJ2c57=7q zBB)DQ=q*`@GiCXRZ^c<90bW^c<-y&JIa~=R7%yO)r>Ip1HBt{=NV9Iw$BgghBm#lQ z@O-?{qBRc49o`5Q&gMq_4cx;1DXNn3+C%A8-5jO$AMU`X*?e5z$sYxJfkY3d;>4+w z3y%g>n%xg^-B7(Zz^r>4swd7Yl>(&-iz~GG2H#RoW`7Lk_O$)&b^RZ9CV?yeAHL${ zdhI}5y4XXPnTl4G2ie6=8ehlXNCuwb4rEK8YjLr=B7WM-VlvS~>fg|1Z>j(}#GhqQ zj10HUWimH=G^_a=%C6=cIHtkr(5fYOY6U#Mps{D ziL=V^JmTP9ao0YsC{r+Je;V2YbJ&FYPS>~_YubJ2Db)vGZ=|6M&BvN}3ZF1eifQ>3 z#-w4a0wq0CVG{GW6Kbm!m86+>-#xzx!T007j$L1@*z~d0b9kM$Q(nDkFZ(Ec@Od@B z25ZjZ`0t_$HT2z5z%0uwEnqF;ImKm$By097$h*Y|lvmZWokpMD#*QjUbQBL`6jG0e zUW^^83`_v12X`FC3nmnFXlZg8pO@V*3Ut&`GXs-XKI3UyR*-o{!fZq%&p@3}GIk*_ z6F{VMAKi1nEE|4(mAI2@kQPdOE99A?4Lf@qT3xRuUjvJ+4|i{EOx_26l6U@D(e-;E z>cNJ;)ZYwPl%y226}S*8e~TSm=H~Aj3XA3h0I#BDSuUi#SJMV|uXz-0b`D@1;yc`ikSDq-dEFNtqaBgonUvSx8*d+ojJ~U{a(fC2cWmL^59A6NV?=oe}mo$ z2VL5c(b~1^+Y^>5ElTS#NEuT1mJHcZ$&~Nu!js$S;&WdG^tehda zvMsq~{6Iua+)}|u40b|zi_N{cEi3M9%12@Kea*J0u#n4US=x%3^UAkbbuGHo&BrVh5waYwtKC2wW}VjP`Ko%oL)m)8uE?*d-~P7{>tG#%Urw$L&Jro{ia z-v73NpE&@rYpdGX@!ZHg(&qZ(n1Q9eA|hxrbK_@5=Zh)OMB)y(`L3HU^Dn)!63l$M zr#m+DBqgicip<&iXb?#iw7kI19;2$fPA-gvZhTE{V2QZem~^ZOcoA^}Gl+?1yTHsI zsR?T?lJ0*z%n!KM-bm_9Q9LK&V8e#?jwkd*6MIg5lsTtega}L5t)lx~FvDr@EGApy zAdZ1kJ$r1_w$19{t)c!yJq4osz#xsGui4TQ^3w=S3!fdr-`$T@N?3Yn2x^(ij%#B} zrhDGw3DXS?8Ti>Zl97)Y&yppXmjE!72<3Wh9YLtD1t>u$o0A}TYq8Jhny+|DnOCHu zt>S!RwNO{zq~+jAdo0$L0Zh7V6nE`Zd8$a$QX;K3-e=E!i>z86D4lvGC*U3eS$kq< zMc9PZQ${nZNEpnwU1)3Cw5x^5i}7_#@f&&jwM3#Eh<5Rc;a@z#p|I_}M+%;;4Jg%$ zP;gN)6xZb4oy{(U`+i?5@q!sCI7RD&$?K@2^{-5zVUnA{W(JrX%MpL6mRBW1+Jl1Sz!%gxF(LH&L9|&_~jN zSZjCAF|?K*S~spT9WXjSHqOpcXkwh(QFaq+o2A=$jrvUJ-J9J9K8yNPRF#9%@xO6B zpehk&bqtm?02CmMY|QdiHz{#I3a8@YH~`dj0i!e6z)KPlgnyTM>l$P)iKMVI zEHZo(3ed=lo5Dj=UiIr!`-6#(HfI9pTE_Hma%upU(S^`5?e9%g4_;ai=wBMM%5$*W ziCRRJ(pe_T?q+vO8$#M43+|n81GowVq~g*z4$uExmg@UgM>ud|Uu7FyWJr z`Xg#04wB)MpZh>AqrR;Vwbx8 z^ejya?UVlH1+uMb*-Y84uKF}Th&kCABT9%(ZW?^V^xaYoXBMZfvukGegA<2?t-mZM z)1`~4t8zzEPQInvMtq}sVIs)Q*h!?zkK`w_Wy&vxTN@_i1cP=4M!(e!${%NXbCScz zQ6;nS8ok#@q3Zmp`+G(dKrQ|xKUAsq(raHq1|T52?@C|2v$gWsCDBdfMc7=b(95b0 zMN8mqrwd-_|NGWqyK7`Vls(U{@c0XdFP^^nv?N7rH9|_;yUQ*%8PGlAhvj@~#~v$< zL7z>Lv^ByX2P>%TNs%5?h|Pz5@7+q%Sn1o2xYd|D3G#qk;x1nvyK|s?AGlS~++a2y zj6{<&<6-z0KsuW}MQuFFv>;n4bHu>vZ~a${Q|yJoCk`xm1-m?{@OiVjwPNif7Abdx zS<|9xZkoaTSW#%I=(IN73$B!kKzA`4%T=xSz{q2fRep`E_8JwOFrq=6z96STJFxG{ zE9votQ*KW;hU6vRja-ls&^ieYi{!f)D|8F+N1onGth;|*dEgegBOq1UGbC&<%NJ*Z zc8Hrv*0dp!Xi#~TERu-m!JQs%?TNcTe>7>0Yw>CyXJ4`whtS%Da8;Frqs(_D?ytYe zNaU8dtAke~&IL}Ws^g4xbekIHT834T(IR#PRnsL6hPAk2Y8Tx`UsXMAXWvv$+()=$ z2tB&~*L)~i7>M%9V^@H^>RX6(qCjZW~0%(2L)>jDE`d zy~GR%dzGJ|UEJ)w-{O$(>E3Z+5G}(i^{2fG?IM)&N9IqJCb+Sw1V7&HfhITb{5@aq ztmTph_SZigxh=Lu4f?j6oMGxwwG^Z}b6hh0=mB_^N*hAacV+b48#<-P{{@mV>{=DV zYVN}(n1%}D$_Lf_n}u#9wDtmJpc-N`h;biSTRMFYy-1}sS=RHo4XJCzpBTCqTFdM? zHsE647y`3Uw65I=)#!ao*JyTUE<6@4OVnXg82&3U0aYc&WxW6cTx7q?su)^mN-0BqiR1-W26xV<+F>SdW1o}{UqaOq;Ag;p!%u*dSYT<}?w!!5LFUC*|JJFRhUf1J=L6UUf0 zD}ia|-Juh@&KSQ%+iIp$duo|uXE@TPRT;K3eXVyU5(V%C6(iB3Yn^W%qE;iRkrE&n zUW{u~Tt~zeID6t-k^k@V^e#^nU@a8>s|5PnxB7cBLhiR9=np(MPqo{i*kbMOX6JOD zs#l>;S*`T@%4Q)TU5DjH6=MH|&2&NL*e$ZSalnGz(R^1iEA`-%Tnqyu>&F^!$;rd(H1i?1S<-&9G9%%{=51age^_RE=2pkM6hJzrR-l zQR&~LeHb}gs>m&%hPlfr}gsj2cm18Q|=+Ty_OM^lw z>xWh-mc0YG;T8H&%c?56Hy%g6cNR)Ej4RVp`HHvTjlmv2`e0O0boRqZSG<75Z`b8nxIt3$tDcXK2!_L4phG&4diu@UcO zB3ypHZ1%Ug$CzzzYt8=GbL3MFu_%Ij16r1ah_?OvIkABzSRS5(+@Q&%W6v@mf!UIp zdC-38RIxXpd%R_Q)#`-xEr24l1=sS6y)>F?KSfu+e-*MHY`k)(#LU@xB=H`Q0}=f= zZp^yho7u7mJd=J5IWiM=V^D9re96;H-x*i^>YCwW& z35`!}-q#9w4Co60AokOMcuAEmFStk1fAr;XPlXMqg)(4UN*Ll$i;G!*@chH|HL8O7 zD!V4HM)2%?VKQX8!-o|}Rzd5IqUGG;Y- zN_X%&A>Tu*D;uYv@xB1;;CDe(O3UPKlBauqI}wm;#u#ZP+Dm%L*(YLmde}2$Z&( z5l8jKHanld9#Q*Nyue~Jug^l>i;ya+?v)m_y`YU1d~T$dLua$*6Y`kI_JY2dxG9_ z>bIzI&bXnUew(achcp;I7wkjAdZdrXkn4C_iK*M}-?pACss4iH8#G9U1dpx+>}lj2 zxP()IQqHts>>ZCmk;gc(rtqP^ieRz^QZkavMEVI->2k8&dWpRsvH+y_PbCo2e0rJ zGGiqsOlGU=1}g)^Ccau5(5ZACO^os&&6Gl(X)V(^eIN}Tj2l9=iKsa`i>*G#`%a(I zkX9>S+N&WvuwMhBmMOhZQzTNqRh9JR8KC2+-k@I6(kO3No-;Sk4kS6eb$AUf(>Y-B zQW1`&gU&1YMbT9?NBJE|fyDv*;m8LLaH1$F)z9W!)A=DGjI!a~{h(-viqxbrVtDWu z`Zx0Q!7kRf+KcyzGrFonrynO9oZ&ainXBVDCqujFJ(fKcvY^0@ZfIKCo~}R#^mWSi)_rbnLJ??zQfeaj3IHr8*udGSHF;M zv~Np%+!(h%G>+gl5vZ}JSTbvD4$vsutY^l){=zP$+*MwF!a#T5(+@}xc?{a;^UcM!A3CrZB^{;{ z;=sOAy937fNdBaMVM9uL9l?58(&(c(oq~`P2~CN-YUDFT1AZvVCr zP1BBnEQh8@duX0}R&;?DNm!bN+;vz>9It6Ni`^@>sTlIBtOL2wq1ib*L#@3U|e^0jD`h$L8CI_hEE_6LOTr4NLSL-+49MM6lESEhuWZg zo%-|Fb9&N{2OK-tQnnFam?{*`Kk3%Mi5<+H9o*xmp;cqH-kj*81dOHQ`0Q9Yqn#Od z2t#O^Ee^PaaA%OL3JG3y^>;3eB10rZh2Z_1!1Hi03GG&kSIE7M*mIe~bwG|qA?;ix zm*v=zuQ(V>o3&hC+=24X=fku@nGZ%Y&Y2fcyr!6b9FW>Lg2*?r5D8Rs{ zDz^TH%Lf1HME{CJYLsbo`(kXV-ad_A7(c<47X~_0JmpVj9bqn@>jLrYeo)RR^f8p* zVP{j2KESkTlAKWa>ntU8hV3?g1nea5=j>X)9hveVb%n_I`8#)aHZhFYeMZKY6h)aJmZf-FCABO#7&5yePiD{+J)%sem#e&dKO=7bswz=||4 z#{|f)!NgY#UL89GZ=x&)E^hNP9H`Y$_lBNyEI|cbiBS@qFvV2(ttF}{pG6aLphs)* zuX`K-W8K4DV&3XF1x8e+fqu|=1~X+{-@8~yF|T#6h)uNCAwDO2o2-i@oWTpR5bn)8 zalRf_d{Yh#XVBj_KP1X-!u=j(<;)$~4=!5F-Ak{VJoC9M&X#&LyoKM^bAkG~g#YII zlP-XGeFGlbCSs0-9E5HBDl@9f3ejuYRvZ%2c!PaZ2Upaf8E^Y$kF>;(qf{`)RmxFY zAA1QKM;m{2I`s7yplFe=tkcE8zzPD%uyeamrsEmMd!xM$-|xJ_f0WbY{{9w-dZ<>i zCo;%Cl#bVaABW+LPOU%hU*))g6>GiKni3{~p7bWet(sRaj(z;({#U}bWYRr8wYW+3 zpI_#+3=g4bQOKF9=n6()WuM6k{t8bnc77#fA>b|x?}GlDMZHFrDAFIs_tdKOfnTo} zF}y2i7ck?clc15*Xm(@qzUeRcvWU*HLp&F_{_54$=a+Ol`#@(Z6JJj9Xlk$h0!~$%nlKKRzHtWf<1QaAAKGqq^H=xQQl3m;c%B34g=f&6`IN%WlKMnoFcUVbJ+0CC8w!{EvrXqm3}*Jz~jVM7jaKD?I}DOm2jjzD-W5?-$+>EMi`#u~R7?l;_W8Dj$230CP#Fvd|pBX7}&Y9b{=f-w8 zQug+N1)l3Y;3LeiVPT~Ang!FU_*Bz+s)S&r^Hf5P1EcpyKZsZ<^0c~Jmi8F>Pk8Rv zzHLQ^9}gLA#N)Aq^1i)6Ffq_v5zG+Ud1XnpfKoZ~tP;91H?4f88QH)B)54POqs1M7 z>e0L?=cHk`JCR6CgqoEF-Ko%DCu?oP-qLj)g8Ne5x`YLul_PcH1W z83oV#(5=dhM$R?s{d~0Tu)$E?kraJ(#YeJR(1eL# z{E%Mwm?O=)SwXVm9sa#{#T{LmxiiMD_Qpenq{``XYUlaGd0$38xi&Y>%Dn^3M6z4M z4%M!>;o{x0x{q)O!YNL*QP!|am6i)8Ghm4>W?8J2x3u@|`toiW?Nr_;hED#(H_%5K z$Qd@E%{{#-%bhzw)iRo5ZtX+A_xwQ~{v_;r(>(vHW%fii80EtjL#ACt&c9p>{Yo)5 zTzO*Yohx4iGa^$11JAyY#;3wL?yG!V`f<>>80a#+Z#!-gP>S9?-VRFLNf5(q4J|Nh_UE+#Fmw1@7}dXLEk-M8u!~HFRKhj<4?=OZG)3I-1#(6| zy*hyJ->Uh!aAY(cy zONf9K(9dW#xt@7^L0aN?w@lsT&snAAm{d-N$o`-|N+1FP-O3$Vx|bSl`RybI86t$O zu96eXU{Hj6t?}l(b)Iz19TNT|bC@8Nq-&!AVn!}XitfKA`mQdx7~F=J^)5oY2iaaQ zy~Hsn5~-M664r%qJf-{Hf`b zL8z;2sp?i)eimpq%yx!J&u@pCPdtM&o{mydfwMnZ%IjJ`HU;skDI!F4`&g<&IX32t z`x*3`h7M`3Hg=i)eG|>djBC^j%nFx-L*6HV@$E$%t|Y6Mcq$Vcmwm!!%Yz z)V3U&i?>Qcn#kmWRrFD_%Mm^{<~rf>-w_(AHbm3Kmhbm{tEKW$OxEdz-a-V6{e9sPa013|=Ip z2oj?QOeMA@kVue6V-n3mW?_GVG(~b<8xva=@|51W*F#N!zy?b+MPDhyX1ub^cN#J( zdlB@92O2^fQzB+*x|KslQoGQ6(~XIY(%IK5>Y&nzno79UI6ON)j{XhM(C$Wuz@)8< zk(pn#^UWSWIg4nwWFiVcceGaD?UpEl$)Dc|R)>-23g#rsFxZ}>&2|XMrWTLcW39gpZ@*R(%Y0 z+cUUvl(n+`Cb?cZge7(mh!XjtrkIJySMO*Ww~+LKCFr6)!%ZKK|C8lP*^AJTr|aRd z>n%eGr1Zg*t0YNsZ#Fa%=Hq+;It7TAZn<+a-1)RU0cTh(`ZwZ`-Pe{|;me$_8GEcc zLg&7y!2dk4K3`x602MMIS4`-H&L#u=P%MqL?BcD{2`#ybGyy~pR*XJU4LH6AWWLJ49oXA^ z{GYWZZ!iwqA2ob2SQqI02>Q(mA_dlK2TeVha^IR0Ftts2@nBerg{hYt@Qs#4`8fis z_O2fG-MPr;dJp0wFCGy?eu0@2eLPS$+Mai4-qlk3z0^l6$Md-u1#F5x3c50s$ zmh+G`e-t?4BAjuxrc3~#^n$IvV!8Q`8?sWm!@+i5&EPz!O`1`q5o9B%3|O(0YDoN&X# zJ0L&y9{5m~VMi#t>-tT=fJU=MA`^oCI2LJkN+lIl5SjV&nE5)L&PvxCS9Fwzg)bs+ zx!$OSTqN(199`(8>}V*mpF~2%%?&xCGJrElFn92ZqrU8#bSZ~tjb|A}O=!CF%4R+L zf}mNq#*p>j9(uoiZCbCaTm?>C&K%@>m6D-`Ds7=GPF0pX7TB_RKe1m7R_?l7&;SN> zQ6AENZktB3ddUa^BGPpq&UC9fv2x`krYr~keL^bTCeE+XvPC+dqC=P)ac?8PIOwDI zQ40pqw9mg~V%p$hAj*;;vXs+U7stLqW~-J4x2ibdB;I)Zz9NYUmb{9p|`OePK8*WzPFnF0KumqT= z*}1_3cFqzRo`k>w+&05>ooa-6pB35>cO2S#&#|60sGwO1c3sB3(zmYM?p=0AIDYdm zaVFlBqXnC7n^q`bQSv}zquTTJWEZM$4p{`J+0b&fPk-2f5%htadXK}0TVtHsvH7PO zcCx&{$7n4E`3q^HM)*Z@Zvl>3%iqRiNP+Ih(cm8n1Bzv77fB!Vec|_V#_}9H=N=7p z`Px>noe=FqZ5tCf2Vn$!eYl7vS2>YB>Tap?knze!6hkavXzw%wju4U?k=&wZ21;|EK51SO+4wrhX~i$#uynQX&SEF6oXhAuXP7uS29 z1ricSQ(uN0Rgrr!2e*U&$$XZI@!b(nw2r2}7>f{@eoe~8Q395|-rutg7)77aH+q%g zy8vD7FjZ=k&X-$qL~u-~u%*T`ec$`BORiK)jW-xFjd5k;i5N+_HjLAX1NK+8w#$kr zaQ0lF6#Eid+8OroEL{uT?94zWKkF?ETGP5ofi|F`%P>x3(^O=Z(GMl6RTZk510emk zGyu!vNisn`I}4#G-S0RMa%@55GUw%CLg#h>(mnkAX8_f)!3B!|5L1J-#0Gk{cz5!i z_VV$|gCi|Mi0duA0)Kq%p6B1g^IV^cjC<~HsY<(OZEdj_cu+*2hIw|F{#0Ucc- +Some raw text. + +directly into the document. + +## F# Formatting as a Library: Specifying the Evaluator and Formatting + +If using F# Formatting as a library the embedding of F# output requires specifying an additional parameter to the +parsing functions discussed in [literate programming documentation](literate.html). +Assuming you have all the references in place, you can now create an instance of +[FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) that represents a wrapper for F# interactive and pass it to all the +functions that parse script files or process script files: + +*) +open FSharp.Formatting.Literate +open FSharp.Formatting.Literate.Evaluation +open FSharp.Formatting.Markdown + +// Sample literate content +let content = + """ +let a = 10 +(*** include-value:a ***)""" + +// Create evaluator and parse script +let fsi = FsiEvaluator() + +let doc = Literate.ParseScriptString(content, fsiEvaluator = fsi) + +Literate.ToHtml(doc) +(** +When the `fsiEvaluator` parameter is specified, the script is evaluated and so you +can use additional commands such as `include-value`. When the evaluator is **not** specified, +it is not created automatically, so the functionality is not available (this way, +you won't accidentally run unexpected code!) + +If you specify the `fsiEvaluator` parameter, but don't want a specific snippet to be evaluated +(because it might throw an exception, for example), you can use the `(*** do-not-eval ***)` +command. + +The constructor of [FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) takes command line parameters for `fsi.exe` that can +be used to specify, for example, defined symbols and other attributes for F# Interactive. + +You can also subscribe to the `EvaluationFailed` event which is fired whenever the evaluation +of an expression fails. You can use that to do tests that verify that all of the code in your +documentation executes without errors. + +## F# Formatting as a Library: Custom formatting functions + +As mentioned earlier, values are formatted using a simple `"%A"` formatter by default. +However, you can specify a formatting function that provides nicer formatting for values +of certain types. For example, let's say that we would want to format F# lists such as +`[1; 2; 3]` as HTML ordered lists `
                  `. + +This can be done by calling [FsiEvaluator.RegisterTransformation](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#RegisterTransformation) on the `FsiEvaluator` instance: + +*) +// Create evaluator & register simple formatter for lists +let fsiEvaluator = FsiEvaluator() + +fsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) -> + // If the type of value is an F# list, format it nicely + if ty.IsGenericType + && ty.GetGenericTypeDefinition() = typedefof> then + let items = + // Get items as objects and create a paragraph for each item + [ for it in Seq.cast (unbox o) -> [ Paragraph([ Literal(it.ToString(), None) ], None) ] ] + // Return option value (success) with ordered list + Some [ ListBlock(MarkdownListKind.Ordered, items, None) ] + else + None) +(** +The function is called with two arguments - `o` is the value to be formatted, and `ty` +is the static type of the value (as inferred by the F# compiler). The sample checks +that the type of the value is a list (containing values of any type), and then it +casts all values in the list to `obj` (for simplicity). Then, we generate Markdown +blocks representing an ordered list. This means that the code will work for both +LaTeX and HTML formatting - but if you only need one, you can simply produce HTML and +embed it in `InlineHtmlBlock`. + +To use the new `FsiEvaluator`, we can use the same style as earlier. This time, we format +a simple list containing strings: + +*) +let listy = + """ +### Formatting demo +let test = ["one";"two";"three"] +(*** include-value:test ***)""" + +let docOl = Literate.ParseScriptString(listy, fsiEvaluator = fsiEvaluator) + +Literate.ToHtml(docOl) +(** +The resulting HTML formatting of the document contains the snippet that defines `test`, +followed by a nicely formatted ordered list: + +
                  +

                  Formatting demo

                  + + + +
                  +1: 
+
                  +
                  +let test = ["one";"two";"three"]
                  +
                  +
                    +

                  1. one

                    2. +

                  2. two

                    3. +

                  3. three

                    4. +
                  +
                  +*) + diff --git a/evaluation.html b/evaluation.html new file mode 100644 index 000000000..b6328916d --- /dev/null +++ b/evaluation.html @@ -0,0 +1,571 @@ + + + + + + + + + + + + + + + + + + Embedding script output + | FSharp.Formatting + + + + + + + + + + + + + +
                  +
                  + + + Header menu logo + FSharp.Formatting + +
                  +
                  + + + + + +
                  +
                  + +
                  +
                  + +

                  Binder  +Script  +Notebook

                  +

                  Embedding script output

                  +

                  For literate F# scripts, you may embed the result of running the script as part of the literate output. +This is a feature of the functions discussed in literate programming and +it is implemented using the F# Compiler service.

                  +

                  Including Console Output

                  +

                  To include the Console output use include-output:

                  +
                  let test = 40 + 2
+
+printf "A result is: %d" test
+(*** include-output ***)
+
                  +

                  The script defines a variable test and then prints it. The console output is included +in the output.

                  +

                  To include the a formatted value use include-it:

                  +
                  [ 0 .. 99 ]
+
+(*** include-it ***)
+
                  +

                  To include the meta output of F# Interactive processing such as type signatures use (*** include-fsi-output ***):

                  +
                  let test = 40 + 3
+
+(*** include-fsi-output ***)
+
                  +

                  To include both console output and F# Interactive output blended use (*** include-fsi-merged-output ***).

                  +
                  let test = 40 + 4
+(*** include-fsi-merged-output ***)
+
                  +

                  You can use the same commands with a named snippet:

                  +
                  (*** include-it: test ***)
+(*** include-fsi-output: test ***)
+(*** include-output: test ***)
+
                  +

                  You can use the include-value command to format a specific value:

                  +
                  let value1 = [ 0 .. 50 ]
+let value2 = [ 51 .. 100 ]
+(*** include-value: value1 ***)
+
                  +

                  Using AddPrinter and AddHtmlPrinter

                  +

                  You can use fsi.AddPrinter, fsi.AddPrintTransformer and fsi.AddHtmlPrinter to extend the formatting of objects.

                  +

                  Emitting Raw Text

                  +

                  To emit raw text in F# literate scripts use the following:

                  +
                  (**
+	(*** raw ***)
+	Some raw text.
+*)
+
                  +

                  which would emit

                  +
                  +Some raw text.
+
                  +

                  directly into the document.

                  +

                  F# Formatting as a Library: Specifying the Evaluator and Formatting

                  +

                  If using F# Formatting as a library the embedding of F# output requires specifying an additional parameter to the +parsing functions discussed in literate programming documentation. +Assuming you have all the references in place, you can now create an instance of +FsiEvaluator that represents a wrapper for F# interactive and pass it to all the +functions that parse script files or process script files:

                  +
                  open FSharp.Formatting.Literate
+open FSharp.Formatting.Literate.Evaluation
+open FSharp.Formatting.Markdown
+
+// Sample literate content
+let content =
+    """
+let a = 10
+(*** include-value:a ***)"""
+
+// Create evaluator and parse script
+let fsi = FsiEvaluator()
+
+let doc = Literate.ParseScriptString(content, fsiEvaluator = fsi)
+
+Literate.ToHtml(doc)
+
                  +

                  When the fsiEvaluator parameter is specified, the script is evaluated and so you +can use additional commands such as include-value. When the evaluator is not specified, +it is not created automatically, so the functionality is not available (this way, +you won't accidentally run unexpected code!)

                  +

                  If you specify the fsiEvaluator parameter, but don't want a specific snippet to be evaluated +(because it might throw an exception, for example), you can use the (*** do-not-eval ***) +command.

                  +

                  The constructor of FsiEvaluator takes command line parameters for fsi.exe that can +be used to specify, for example, defined symbols and other attributes for F# Interactive.

                  +

                  You can also subscribe to the EvaluationFailed event which is fired whenever the evaluation +of an expression fails. You can use that to do tests that verify that all of the code in your +documentation executes without errors.

                  +

                  F# Formatting as a Library: Custom formatting functions

                  +

                  As mentioned earlier, values are formatted using a simple "%A" formatter by default. +However, you can specify a formatting function that provides nicer formatting for values +of certain types. For example, let's say that we would want to format F# lists such as +[1; 2; 3] as HTML ordered lists <ol>.

                  +

                  This can be done by calling FsiEvaluator.RegisterTransformation on the FsiEvaluator instance:

                  +
                  // Create evaluator & register simple formatter for lists
+let fsiEvaluator = FsiEvaluator()
+
+fsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) ->
+    // If the type of value is an F# list, format it nicely
+    if ty.IsGenericType
+       && ty.GetGenericTypeDefinition() = typedefof<list<_>> then
+        let items =
+            // Get items as objects and create a paragraph for each item
+            [ for it in Seq.cast<obj> (unbox o) -> [ Paragraph([ Literal(it.ToString(), None) ], None) ] ]
+        // Return option value (success) with ordered list
+        Some [ ListBlock(MarkdownListKind.Ordered, items, None) ]
+    else
+        None)
+
                  +

                  The function is called with two arguments - o is the value to be formatted, and ty +is the static type of the value (as inferred by the F# compiler). The sample checks +that the type of the value is a list (containing values of any type), and then it +casts all values in the list to obj (for simplicity). Then, we generate Markdown +blocks representing an ordered list. This means that the code will work for both +LaTeX and HTML formatting - but if you only need one, you can simply produce HTML and +embed it in InlineHtmlBlock.

                  +

                  To use the new FsiEvaluator, we can use the same style as earlier. This time, we format +a simple list containing strings:

                  +
                  let listy =
+    """
+### Formatting demo
+let test = ["one";"two";"three"]
+(*** include-value:test ***)"""
+
+let docOl = Literate.ParseScriptString(listy, fsiEvaluator = fsiEvaluator)
+
+Literate.ToHtml(docOl)
+
                  +

                  The resulting HTML formatting of the document contains the snippet that defines test, +followed by a nicely formatted ordered list:

                  +
                  +

                  Formatting demo

                  + + + +
                  +1: 
+
                  +
                  +let test = ["one";"two";"three"]
                  +
                  +
                    +

                  1. one

                    2. +

                  2. two

                    3. +

                  3. three

                    4. +
                  +
                  + +
                  val test: int
                  +
                  val printf: format: Printf.TextWriterFormat<'T> -> 'T
                  +
                  val value1: int list
                  +
                  val value2: int list
                  +
                  Multiple items
                  namespace FSharp

                  --------------------
                  namespace Microsoft.FSharp
                  +
                  namespace FSharp.Formatting
                  +
                  namespace FSharp.Formatting.Literate
                  +
                  namespace FSharp.Formatting.Literate.Evaluation
                  +
                  namespace FSharp.Formatting.Markdown
                  +
                  val content: string
                  +
                  val fsi: FsiEvaluator
                  +
                  Multiple items
                  type FsiEvaluator = + interface IFsiEvaluator + new: ?options: string array * ?fsiObj: obj * ?addHtmlPrinter: bool * ?discardStdOut: bool * ?disableFsiObj: bool * ?onError: (string -> unit) -> FsiEvaluator + member RegisterTransformation: f: (obj * Type * int -> MarkdownParagraph list option) -> unit + member EvaluationFailed: IEvent<FsiEvaluationFailedInfo>
                  <summary> + A wrapper for F# interactive service that is used to evaluate inline snippets +</summary>

                  --------------------
                  new: ?options: string array * ?fsiObj: obj * ?addHtmlPrinter: bool * ?discardStdOut: bool * ?disableFsiObj: bool * ?onError: (string -> unit) -> FsiEvaluator
                  +
                  val doc: LiterateDocument
                  +
                  type Literate = + static member ConvertMarkdownFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?substitutions: (ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FrontMatterFile array -> unit + static member ConvertScriptFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?substitutions: (ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FrontMatterFile array -> unit + static member ParseAndCheckScriptFile: path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument + static member ParseMarkdownFile: path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument + static member ParseMarkdownString: content: string * ?path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument + static member ParsePynbString: content: string * ?path: string * ?definedSymbols: string list * ?references: bool * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument + static member ParseScriptString: content: string * ?path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument + static member ToFsx: doc: LiterateDocument * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string + static member ToHtml: doc: LiterateDocument * ?prefix: string * ?lineNumbers: bool * ?generateAnchors: bool * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?tokenKindToCss: (TokenKind -> string) -> string + static member ToLatex: doc: LiterateDocument * ?prefix: string * ?lineNumbers: bool * ?generateAnchors: bool * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string + ...
                  <summary> + This type provides three simple methods for calling the literate programming tool. + The <c>ConvertMarkdownFile</c> and <c>ConvertScriptFile</c> methods process a single Markdown document + and F# script, respectively. The <c>ConvertDirectory</c> method handles an entire directory tree + (looking for <c>*.fsx</c> and <c>*.md</c> files). + </summary>
                  <namespacedoc><summary>Functionality to support literate programming for F# scripts</summary></namespacedoc>
                  +
                  static member Literate.ParseScriptString: content: string * ?path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
                  +
                  static member Literate.ToHtml: doc: LiterateDocument * ?prefix: string * ?lineNumbers: bool * ?generateAnchors: bool * ?substitutions: (FSharp.Formatting.Templating.ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?tokenKindToCss: (FSharp.Formatting.CodeFormat.TokenKind -> string) -> string
                  +
                  val fsiEvaluator: FsiEvaluator
                  +
                  member FsiEvaluator.RegisterTransformation: f: (obj * System.Type * int -> MarkdownParagraph list option) -> unit
                  +
                  val o: obj
                  +
                  val ty: System.Type
                  +
                  val _executionCount: int
                  +
                  property System.Type.IsGenericType: bool with get
                  +
                  System.Type.GetGenericTypeDefinition() : System.Type
                  +
                  val typedefof<'T> : System.Type
                  +
                  type 'T list = List<'T>
                  +
                  val items: MarkdownParagraph list list
                  +
                  val it: obj
                  +
                  module Seq + +from Microsoft.FSharp.Collections
                  +
                  val cast: source: System.Collections.IEnumerable -> 'T seq
                  +
                  type obj = System.Object
                  +
                  val unbox: value: obj -> 'T
                  +
                  union case MarkdownParagraph.Paragraph: body: MarkdownSpans * range: MarkdownRange option -> MarkdownParagraph
                  +
                  Multiple items
                  union case MarkdownSpan.Literal: text: string * range: MarkdownRange option -> MarkdownSpan

                  --------------------
                  type LiteralAttribute = + inherit Attribute + new: unit -> LiteralAttribute

                  --------------------
                  new: unit -> LiteralAttribute
                  +
                  System.Object.ToString() : string
                  +
                  union case Option.None: Option<'T>
                  +
                  union case Option.Some: Value: 'T -> Option<'T>
                  +
                  union case MarkdownParagraph.ListBlock: kind: MarkdownListKind * items: MarkdownParagraphs list * range: MarkdownRange option -> MarkdownParagraph
                  <summary> + A Markdown List block +</summary>
                  +
                  [<Struct>] +type MarkdownListKind = + | Ordered + | Unordered
                  <summary> + A list kind can be Ordered or Unordered corresponding to <c>&lt;ol&gt;</c> and <c>&lt;ul&gt;</c> elements + </summary>
                  +
                  union case MarkdownListKind.Ordered: MarkdownListKind
                  +
                  val listy: string
                  +
                  val docOl: LiterateDocument
                  + +
                  +
                  + + + +
                  +
                    +

                    Type something to start searching.

                    +
                    +                     + + + + + + + + \ No newline at end of file diff --git a/evaluation.ipynb b/evaluation.ipynb new file mode 100644 index 000000000..3b3621baa --- /dev/null +++ b/evaluation.ipynb @@ -0,0 +1,347 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "#r \"nuget: FSharp.Formatting,1.0.0\"\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=evaluation.ipynb)\u0026emsp;\n", + "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//evaluation.fsx)\u0026emsp;\n", + "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//evaluation.ipynb)\n", + "\n", + "# Embedding script output\n", + "\n", + "For literate F# scripts, you may embed the result of running the script as part of the literate output.\n", + "This is a feature of the functions discussed in [literate programming](literate.html) and\n", + "it is implemented using the [F# Compiler service](http://fsharp.github.io/FSharp.Compiler.Service/).\n", + "\n", + "## Including Console Output\n", + "\n", + "To include the Console output use `include-output`:\n", + "\n", + " let test = 40 + 2\n", + "\n", + " printf \"A result is: %d\" test\n", + " (*** include-output ***)\n", + "\n", + "The script defines a variable `test` and then prints it. The console output is included\n", + "in the output.\n", + "\n", + "To include the a formatted value use `include-it`:\n", + "\n", + " [ 0 .. 99 ]\n", + "\n", + " (*** include-it ***)\n", + "\n", + "\n", + "To include the meta output of F# Interactive processing such as type signatures use `(*** include-fsi-output ***)`:\n", + "\n", + " let test = 40 + 3\n", + "\n", + " (*** include-fsi-output ***)\n", + "\n", + "To include both console output and F# Interactive output blended use `(*** include-fsi-merged-output ***)`.\n", + "\n", + " let test = 40 + 4\n", + " (*** include-fsi-merged-output ***)\n", + "\n", + "You can use the same commands with a named snippet:\n", + "\n", + " (*** include-it: test ***)\n", + " (*** include-fsi-output: test ***)\n", + " (*** include-output: test ***)\n", + "\n", + "You can use the `include-value` command to format a specific value:\n", + "\n", + " let value1 = [ 0 .. 50 ]\n", + " let value2 = [ 51 .. 100 ]\n", + " (*** include-value: value1 ***)\n", + "\n", + "## Using AddPrinter and AddHtmlPrinter\n", + "\n", + "You can use `fsi.AddPrinter`, `fsi.AddPrintTransformer` and `fsi.AddHtmlPrinter` to extend the formatting of objects.\n", + "\n", + "## Emitting Raw Text\n", + "\n", + "To emit raw text in F# literate scripts use the following:\n", + "\n", + "\t(**\n", + "\t\t(*** raw ***)\n", + "\t\tSome raw text.\n", + "\t*)\n", + "\n", + "which would emit\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "\u003cpre\u003e\n", + "Some raw text.\n", + "\u003c/pre\u003e\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "directly into the document.\n", + "\n", + "## F# Formatting as a Library: Specifying the Evaluator and Formatting\n", + "\n", + "If using F# Formatting as a library the embedding of F# output requires specifying an additional parameter to the\n", + "parsing functions discussed in [literate programming documentation](literate.html).\n", + "Assuming you have all the references in place, you can now create an instance of\n", + "[FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) that represents a wrapper for F# interactive and pass it to all the\n", + "functions that parse script files or process script files:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "open FSharp.Formatting.Literate\n", + "open FSharp.Formatting.Literate.Evaluation\n", + "open FSharp.Formatting.Markdown\n", + "\n", + "// Sample literate content\n", + "let content =\n", + " \"\"\"\n", + "let a = 10\n", + "(*** include-value:a ***)\"\"\"\n", + "\n", + "// Create evaluator and parse script\n", + "let fsi = FsiEvaluator()\n", + "\n", + "let doc = Literate.ParseScriptString(content, fsiEvaluator = fsi)\n", + "\n", + "Literate.ToHtml(doc)\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "When the `fsiEvaluator` parameter is specified, the script is evaluated and so you\n", + "can use additional commands such as `include-value`. When the evaluator is **not** specified,\n", + "it is not created automatically, so the functionality is not available (this way,\n", + "you won\u0027t accidentally run unexpected code!)\n", + "\n", + "If you specify the `fsiEvaluator` parameter, but don\u0027t want a specific snippet to be evaluated\n", + "(because it might throw an exception, for example), you can use the `(*** do-not-eval ***)`\n", + "command.\n", + "\n", + "The constructor of [FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) takes command line parameters for `fsi.exe` that can\n", + "be used to specify, for example, defined symbols and other attributes for F# Interactive.\n", + "\n", + "You can also subscribe to the `EvaluationFailed` event which is fired whenever the evaluation\n", + "of an expression fails. You can use that to do tests that verify that all of the code in your\n", + "documentation executes without errors.\n", + "\n", + "## F# Formatting as a Library: Custom formatting functions\n", + "\n", + "As mentioned earlier, values are formatted using a simple `\"%A\"` formatter by default.\n", + "However, you can specify a formatting function that provides nicer formatting for values\n", + "of certain types. For example, let\u0027s say that we would want to format F# lists such as\n", + "`[1; 2; 3]` as HTML ordered lists `\u003col\u003e`.\n", + "\n", + "This can be done by calling [FsiEvaluator.RegisterTransformation](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#RegisterTransformation) on the `FsiEvaluator` instance:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "// Create evaluator \u0026 register simple formatter for lists\n", + "let fsiEvaluator = FsiEvaluator()\n", + "\n", + "fsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) -\u003e\n", + " // If the type of value is an F# list, format it nicely\n", + " if ty.IsGenericType\n", + " \u0026\u0026 ty.GetGenericTypeDefinition() = typedefof\u003clist\u003c_\u003e\u003e then\n", + " let items =\n", + " // Get items as objects and create a paragraph for each item\n", + " [ for it in Seq.cast\u003cobj\u003e (unbox o) -\u003e [ Paragraph([ Literal(it.ToString(), None) ], None) ] ]\n", + " // Return option value (success) with ordered list\n", + " Some [ ListBlock(MarkdownListKind.Ordered, items, None) ]\n", + " else\n", + " None)\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "The function is called with two arguments - `o` is the value to be formatted, and `ty`\n", + "is the static type of the value (as inferred by the F# compiler). The sample checks\n", + "that the type of the value is a list (containing values of any type), and then it\n", + "casts all values in the list to `obj` (for simplicity). Then, we generate Markdown\n", + "blocks representing an ordered list. This means that the code will work for both\n", + "LaTeX and HTML formatting - but if you only need one, you can simply produce HTML and\n", + "embed it in `InlineHtmlBlock`.\n", + "\n", + "To use the new `FsiEvaluator`, we can use the same style as earlier. This time, we format\n", + "a simple list containing strings:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "let listy =\n", + " \"\"\"\n", + "### Formatting demo\n", + "let test = [\"one\";\"two\";\"three\"]\n", + "(*** include-value:test ***)\"\"\"\n", + "\n", + "let docOl = Literate.ParseScriptString(listy, fsiEvaluator = fsiEvaluator)\n", + "\n", + "Literate.ToHtml(docOl)\n" + ] + } +, + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "The resulting HTML formatting of the document contains the snippet that defines `test`,\n", + "followed by a nicely formatted ordered list:\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "\u003cblockquote\u003e\n", + "\u003ch3\u003eFormatting demo\u003c/h3\u003e\n", + "\u003ctable class=\"pre\"\u003e\u003ctr\u003e\u003ctd class=\"lines\"\u003e\u003cpre class=\"fssnip\"\u003e\n", + "\u003cspan class=\"l\"\u003e1: \u003c/span\u003e\n", + "\u003c/pre\u003e\n", + "\u003c/td\u003e\n", + "\u003ctd class=\"snippet\"\u003e\u003cpre class=\"fssnip\"\u003e\n", + "\u003cspan class=\"k\"\u003elet\u003c/span\u003e \u003cspanclass=\"i\"\u003etest\u003c/span\u003e \u003cspan class=\"o\"\u003e=\u003c/span\u003e [\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"s\"\u003eone\u003c/span\u003e\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e;\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"s\"\u003etwo\u003c/span\u003e\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e;\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e\u003cspan class=\"s\"\u003ethree\u003c/span\u003e\u003cspan class=\"s\"\u003e\u0026quot;\u003c/span\u003e]\u003c/pre\u003e\n", + "\u003c/td\u003e\n", + "\u003c/tr\u003e\n", + "\u003c/table\u003e\n", + "\u003col\u003e\n", + "\u003cli\u003e\u003cp\u003eone\u003c/p\u003e\u003c/li\u003e\n", + "\u003cli\u003e\u003cp\u003etwo\u003c/p\u003e\u003c/li\u003e\n", + "\u003cli\u003e\u003cp\u003ethree\u003c/p\u003e\u003c/li\u003e\n", + "\u003c/ol\u003e\n", + "\u003c/blockquote\u003e\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/evaluation.md b/evaluation.md new file mode 100644 index 000000000..62c93f7c2 --- /dev/null +++ b/evaluation.md @@ -0,0 +1,205 @@ +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=evaluation.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//evaluation.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//evaluation.ipynb) + +# Embedding script output + +For literate F# scripts, you may embed the result of running the script as part of the literate output. +This is a feature of the functions discussed in [literate programming](literate.html) and +it is implemented using the [F# Compiler service](http://fsharp.github.io/FSharp.Compiler.Service/). + +## Including Console Output + +To include the Console output use `include-output`: + +```fsharp +let test = 40 + 2 + +printf "A result is: %d" test +(*** include-output ***) + +``` + +The script defines a variable `test` and then prints it. The console output is included +in the output. + +To include the a formatted value use `include-it`: + +```fsharp +[ 0 .. 99 ] + +(*** include-it ***) + +``` + +To include the meta output of F# Interactive processing such as type signatures use `(*** include-fsi-output ***)`: + +```fsharp +let test = 40 + 3 + +(*** include-fsi-output ***) + +``` + +To include both console output and F# Interactive output blended use `(*** include-fsi-merged-output ***)`. + +```fsharp +let test = 40 + 4 +(*** include-fsi-merged-output ***) + +``` + +You can use the same commands with a named snippet: + +```fsharp +(*** include-it: test ***) +(*** include-fsi-output: test ***) +(*** include-output: test ***) + +``` + +You can use the `include-value` command to format a specific value: + +```fsharp +let value1 = [ 0 .. 50 ] +let value2 = [ 51 .. 100 ] +(*** include-value: value1 ***) + +``` + +## Using AddPrinter and AddHtmlPrinter + +You can use `fsi.AddPrinter`, `fsi.AddPrintTransformer` and `fsi.AddHtmlPrinter` to extend the formatting of objects. + +## Emitting Raw Text + +To emit raw text in F# literate scripts use the following: + +```fsharp +(** + (*** raw ***) + Some raw text. +*) + +``` + +which would emit + +
                    +Some raw text.
+
                    +directly into the document. + +## F# Formatting as a Library: Specifying the Evaluator and Formatting + +If using F# Formatting as a library the embedding of F# output requires specifying an additional parameter to the +parsing functions discussed in [literate programming documentation](literate.html). +Assuming you have all the references in place, you can now create an instance of +[FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) that represents a wrapper for F# interactive and pass it to all the +functions that parse script files or process script files: + +```fsharp +open FSharp.Formatting.Literate +open FSharp.Formatting.Literate.Evaluation +open FSharp.Formatting.Markdown + +// Sample literate content +let content = + """ +let a = 10 +(*** include-value:a ***)""" + +// Create evaluator and parse script +let fsi = FsiEvaluator() + +let doc = Literate.ParseScriptString(content, fsiEvaluator = fsi) + +Literate.ToHtml(doc) +``` + +When the `fsiEvaluator` parameter is specified, the script is evaluated and so you +can use additional commands such as `include-value`. When the evaluator is **not** specified, +it is not created automatically, so the functionality is not available (this way, +you won't accidentally run unexpected code!) + +If you specify the `fsiEvaluator` parameter, but don't want a specific snippet to be evaluated +(because it might throw an exception, for example), you can use the `(*** do-not-eval ***)` +command. + +The constructor of [FsiEvaluator](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html) takes command line parameters for `fsi.exe` that can +be used to specify, for example, defined symbols and other attributes for F# Interactive. + +You can also subscribe to the `EvaluationFailed` event which is fired whenever the evaluation +of an expression fails. You can use that to do tests that verify that all of the code in your +documentation executes without errors. + +## F# Formatting as a Library: Custom formatting functions + +As mentioned earlier, values are formatted using a simple `"%A"` formatter by default. +However, you can specify a formatting function that provides nicer formatting for values +of certain types. For example, let's say that we would want to format F# lists such as +`[1; 2; 3]` as HTML ordered lists `
                      `. + +This can be done by calling [FsiEvaluator.RegisterTransformation](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#RegisterTransformation) on the `FsiEvaluator` instance: + +```fsharp +// Create evaluator & register simple formatter for lists +let fsiEvaluator = FsiEvaluator() + +fsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) -> + // If the type of value is an F# list, format it nicely + if ty.IsGenericType + && ty.GetGenericTypeDefinition() = typedefof> then + let items = + // Get items as objects and create a paragraph for each item + [ for it in Seq.cast (unbox o) -> [ Paragraph([ Literal(it.ToString(), None) ], None) ] ] + // Return option value (success) with ordered list + Some [ ListBlock(MarkdownListKind.Ordered, items, None) ] + else + None) +``` + +The function is called with two arguments - `o` is the value to be formatted, and `ty` +is the static type of the value (as inferred by the F# compiler). The sample checks +that the type of the value is a list (containing values of any type), and then it +casts all values in the list to `obj` (for simplicity). Then, we generate Markdown +blocks representing an ordered list. This means that the code will work for both +LaTeX and HTML formatting - but if you only need one, you can simply produce HTML and +embed it in `InlineHtmlBlock`. + +To use the new `FsiEvaluator`, we can use the same style as earlier. This time, we format +a simple list containing strings: + +```fsharp +let listy = + """ +### Formatting demo +let test = ["one";"two";"three"] +(*** include-value:test ***)""" + +let docOl = Literate.ParseScriptString(listy, fsiEvaluator = fsiEvaluator) + +Literate.ToHtml(docOl) +``` + +The resulting HTML formatting of the document contains the snippet that defines `test`, +followed by a nicely formatted ordered list: + +
                      +

                      Formatting demo

                      + + + +
                      +1: 
+
                      +
                      +let test = ["one";"two";"three"]
                      +
                      +
                        +

                      1. one

                        2. +

                      2. two

                        3. +

                      3. three

                        4. +
                      +
                      + diff --git a/evaluation.tex b/evaluation.tex new file mode 100644 index 000000000..055534eea --- /dev/null +++ b/evaluation.tex @@ -0,0 +1,318 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + + + +\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=evaluation.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-binder.svg} +\caption{Binder} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//evaluation.fsx}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-script.svg} +\caption{Script} +\end{figure} +}  +\href{https://fsprojects.github.io/FSharp.Formatting//evaluation.ipynb}{\begin{figure}[htbp]\centering +\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg} +\caption{Notebook} +\end{figure} +} +\section*{Embedding script output} + + + +For literate F\# scripts, you may embed the result of running the script as part of the literate output. +This is a feature of the functions discussed in \href{literate.html}{literate programming} and +it is implemented using the \href{http://fsharp.github.io/FSharp.Compiler.Service/}{F\# Compiler service}. +\subsection*{Including Console Output} + + + +To include the Console output use \texttt{include-output}: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{test} \ops{=} \num{40} \ops{+} \num{2} + +\lfun{printf} \str{"A result is: }\lprf{\%d}\str{"} \id{test} +\com{(*** include-output ***)} + + +\end{lstlisting} + + + +The script defines a variable \texttt{test} and then prints it. The console output is included +in the output. + + +To include the a formatted value use \texttt{include-it}: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +{[} \num{0} \ops{..} \num{99} {]} + +\com{(*** include-it ***)} + + +\end{lstlisting} + + + +To include the meta output of F\# Interactive processing such as type signatures use \texttt{(*** include-fsi-output ***)}: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{test} \ops{=} \num{40} \ops{+} \num{3} + +\com{(*** include-fsi-output ***)} + + +\end{lstlisting} + + + +To include both console output and F\# Interactive output blended use \texttt{(*** include-fsi-merged-output ***)}. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{test} \ops{=} \num{40} \ops{+} \num{4} +\com{(*** include-fsi-merged-output ***)} + + +\end{lstlisting} + + + +You can use the same commands with a named snippet: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{(*** include-it: test ***)} +\com{(*** include-fsi-output: test ***)} +\com{(*** include-output: test ***)} + + +\end{lstlisting} + + + +You can use the \texttt{include-value} command to format a specific value: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{value1} \ops{=} {[} \num{0} \ops{..} \num{50} {]} +\kwd{let} \id{value2} \ops{=} {[} \num{51} \ops{..} \num{100} {]} +\com{(*** include-value: value1 ***)} + + +\end{lstlisting} + +\subsection*{Using AddPrinter and AddHtmlPrinter} + + + +You can use \texttt{fsi.AddPrinter}, \texttt{fsi.AddPrintTransformer} and \texttt{fsi.AddHtmlPrinter} to extend the formatting of objects. +\subsection*{Emitting Raw Text} + + + +To emit raw text in F\# literate scripts use the following: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{(**} +\com{ (*** raw ***)} +\com{ Some raw text.} +\com{*)} + + +\end{lstlisting} + + + +which would emit +
                      +Some raw text.
+
                      + + +directly into the document. +\subsection*{F\# Formatting as a Library: Specifying the Evaluator and Formatting} + + + +If using F\# Formatting as a library the embedding of F\# output requires specifying an additional parameter to the +parsing functions discussed in \href{literate.html}{literate programming documentation}. +Assuming you have all the references in place, you can now create an instance of +\href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html}{FsiEvaluator} that represents a wrapper for F\# interactive and pass it to all the +functions that parse script files or process script files: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Literate} +\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Literate}{.}\id{Evaluation} +\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Markdown} + +\com{// Sample literate content} +\kwd{let} \id{content} \ops{=} + \str{"""} +\str{let a = 10} +\str{(*** include-value:a ***)"""} + +\com{// Create evaluator and parse script} +\kwd{let} \id{fsi} \ops{=} \lfun{FsiEvaluator}{(}{)} + +\kwd{let} \id{doc} \ops{=} \ltyp{Literate}{.}\id{ParseScriptString}{(}\id{content}{,} \lfun{fsiEvaluator} \ops{=} \id{fsi}{)} + +\ltyp{Literate}{.}\id{ToHtml}{(}\id{doc}{)} + +\end{lstlisting} + + + +When the \texttt{fsiEvaluator} parameter is specified, the script is evaluated and so you +can use additional commands such as \texttt{include-value}. When the evaluator is \emph{not} specified, +it is not created automatically, so the functionality is not available (this way, +you won't accidentally run unexpected code!) + + +If you specify the \texttt{fsiEvaluator} parameter, but don't want a specific snippet to be evaluated +(because it might throw an exception, for example), you can use the \texttt{(*** do-not-eval ***)} +command. + + +The constructor of \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html}{FsiEvaluator} takes command line parameters for \texttt{fsi.exe} that can +be used to specify, for example, defined symbols and other attributes for F\# Interactive. + + +You can also subscribe to the \texttt{EvaluationFailed} event which is fired whenever the evaluation +of an expression fails. You can use that to do tests that verify that all of the code in your +documentation executes without errors. +\subsection*{F\# Formatting as a Library: Custom formatting functions} + + + +As mentioned earlier, values are formatted using a simple \texttt{"\%A"} formatter by default. +However, you can specify a formatting function that provides nicer formatting for values +of certain types. For example, let's say that we would want to format F\# lists such as +\texttt{[1; 2; 3]} as HTML ordered lists \texttt{
                        }. + + +This can be done by calling \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html\#RegisterTransformation}{FsiEvaluator.RegisterTransformation} on the \texttt{FsiEvaluator} instance: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\com{// Create evaluator \& register simple formatter for lists} +\kwd{let} \id{fsiEvaluator} \ops{=} \lfun{FsiEvaluator}{(}{)} + +\id{fsiEvaluator}{.}\id{RegisterTransformation}{(}\kwd{fun} {(}\lfun{o}{,} \lfun{ty}{,} \id{\_executionCount}{)} \kwd{->} + \com{// If the type of value is an F\# list, format it nicely} + \kwd{if} \lfun{ty}{.}\id{IsGenericType} + \ops{\&\&} \lfun{ty}{.}\id{GetGenericTypeDefinition}{(}{)} \ops{=} \kwd{typedefof}{<}\ltyp{list}{<}\id{\_}{>}{>} \kwd{then} + \kwd{let} \lfun{items} \ops{=} + \com{// Get items as objects and create a paragraph for each item} + {[} \kwd{for} \lfun{it} \kwd{in} \ltyp{Seq}{.}\id{cast}{<}\ltyp{obj}{>} {(}\lfun{unbox} \lfun{o}{)} \kwd{->} {[} {Paragraph}{(}{[} {Literal}{(}\lfun{it}{.}\id{ToString}{(}{)}{,} {None}{)} {]}{,} {None}{)} {]} {]} + \com{// Return option value (success) with ordered list} + {Some} {[} {ListBlock}{(}\ltyp{MarkdownListKind}{.}\id{Ordered}{,} \lfun{items}{,} {None}{)} {]} + \kwd{else} + {None}{)} + +\end{lstlisting} + + + +The function is called with two arguments - \texttt{o} is the value to be formatted, and \texttt{ty} +is the static type of the value (as inferred by the F\# compiler). The sample checks +that the type of the value is a list (containing values of any type), and then it +casts all values in the list to \texttt{obj} (for simplicity). Then, we generate Markdown +blocks representing an ordered list. This means that the code will work for both +LaTeX and HTML formatting - but if you only need one, you can simply produce HTML and +embed it in \texttt{InlineHtmlBlock}. + + +To use the new \texttt{FsiEvaluator}, we can use the same style as earlier. This time, we format +a simple list containing strings: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{let} \id{listy} \ops{=} + \str{"""} +\str{\#\#\# Formatting demo} +\str{let test = ["one";"two";"three"]} +\str{(*** include-value:test ***)"""} + +\kwd{let} \id{docOl} \ops{=} \ltyp{Literate}{.}\id{ParseScriptString}{(}\id{listy}{,} \lfun{fsiEvaluator} \ops{=} \id{fsiEvaluator}{)} + +\ltyp{Literate}{.}\id{ToHtml}{(}\id{docOl}{)} + +\end{lstlisting} + + + +The resulting HTML formatting of the document contains the snippet that defines \texttt{test}, +followed by a nicely formatted ordered list: +
                        +

                        Formatting demo

                        + + + +
                        +1: 
+
                        +
                        +let test = ["one";"two";"three"]
                        +
                        +
                          +

                        1. one

                          2. +

                        2. two

                          3. +

                        3. three

                          4. +
                        +
                        + + +\end{document} \ No newline at end of file diff --git a/img/badge-binder.svg b/img/badge-binder.svg new file mode 100644 index 000000000..8df9f49a7 --- /dev/null +++ b/img/badge-binder.svg @@ -0,0 +1 @@ +Run in BinderRun in Binder \ No newline at end of file diff --git a/img/badge-notebook.svg b/img/badge-notebook.svg new file mode 100644 index 000000000..a001b5449 --- /dev/null +++ b/img/badge-notebook.svg @@ -0,0 +1 @@ +Download notebookDownload notebook \ No newline at end of file diff --git a/img/badge-script.svg b/img/badge-script.svg new file mode 100644 index 000000000..90c93ebe5 --- /dev/null +++ b/img/badge-script.svg @@ -0,0 +1 @@ +Download scriptDownload script \ No newline at end of file diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..1b43557a9d87e809bbe4615df466365ac3aff856 GIT binary patch literal 15086 zcmeHOYit}>6~5zj>=aTZp&&?;)M-kjwkY0p9=moBb$Jz0LWK${Mf{+VP^rXA6@>sn zaU8XI*iK7}N<)fLASr6n(31GM>!jW^Z4sp5O=8D(ye=yIC=Uljaaza2_uai`xt`AK z&TiI;k+{ zvO(R$tqo3k=ZXr{p9AeXb0qrW>7Ljw`pkzzbd#;|S*ZUM&VgJvi1Cts0Q#7zYhRRu{36irEE}DOi@J+I86!{quYm3} z*Wah^&vvh>GB&y_{Sn$^J7li{4I3TW_yXvgp#A*)mp@)P8?qgi?n%_IG`czt$Swg5 zfh3NN$p2F0ZNULjMHD?{Vl{Mp^LOys~wrE;f3$C6*t)KYlOtn@@Gr z3Ff@IVxzY$QSs#ZHO{d|R#)|R#VUt;V@{A?*Hwx%(WumTjZ$NXaCECu&mL3i-chC6 zKrf*FN3@;AZ&z0+jUcX1x^UqsQ$ao|(2veYU$g@Az$ug2P-f^Gl=I0P zf^yfPjFc!O;~?3Zs7pNb9`YY|t4e!A??8G>JjN!n4 z==(vj;ak41Mtu_x(bFhYf(Zu{Z z_@t=|hMvLjZw3Td0=ylfz zgN#Rx0~rseP+x2?7~hHOVT(R!)9d>r+7^PAfyB37e{lT)+5y-3gk8=x$-_OU)2~f} zf&1QfQI`e!p9j&m*tKyyY-G6q6dA!d#XsdN|5u~_cjI63Kz`1&eaYC>Ie=~MOKG2L z%cQAG{G0mBcT6DSV6=Kj#gnZ?2Kd$5&~OYqYVe^K@;dn}4=%iPet# zbCic~?Td9O7~4*f7+N5|R`g-h&o|?j9Na-!T+b36FE0YaebnuHDE?-0*kpf8&LwW~ zP5vn(7wDV6vlM|r_r*ZBJ_GvsX5Km9ZlzuDg1#xo5*EY3riK{qzk6YuV_NQclJ9Y} zeT4SFL;I#YO92dePMG_@?7x_I@%=B<_1q}McNRhRZ@`$;{yqCISy#@&=MB^bf5SMp zZHKMN9Z=CL}iOOdlTzy$4T|4{5 zJ*yn}*7p)yZaV9^dtNH|8A2HUu3gSIy6(9e*F8Jebw{gR_h`g*n;qA6Ho23Lbkjt2 zrg8l8v6`_3<8w206V>T;Xa%v(HvTp-E7M3>>S$fspe@>@ZTdLh@EQAo&kSTM9a|rZ55d*Mi_l#}vRr~H)Q-%Dm zINhClmN=th0Cv3}z?tV0c!o8=u0r0qkNBafM{sVQkud}K0gDtf`skZ7kI1z08T#LoSX-h)~B7yR4{ zFowtb4_)gFrB+<>7=TsAJF&k8;`vgaseJHr&n|oE1DFSu!`XB7l(niHISpe2IPJU( zcAks%**E~deI95(-4oT%XAsLpjUf+qo@EQ+w_`}5Pu|3QfnSsufX{Et$n%J>_!)yd zb4d>*>n=Aj=zB+){x3zwlXuQlj&~cojo-We2wq|rlC~ExmgY}q3?cGP>?B!#1`VEv z4PH413U=WV!wJaYO}rjUW$g!G3Yx2eSvdQGeR2--_ZDKoJG2_$>Nhb6R>3Y@+J6f< z{hk)QEHMB}q4Dm;&b8>H#E$pSI&NTD3>p9tuV5AI!lj+DUPXQI3yPrx?3@!CJI<8V z9h(ysnRHZR02am&wjYKedyR=f=YaKM3UCxXW-RRUQGWoW-!GgzRA=`?p%~;j*-O|b zm2`H8-;&2nvSoD@^m{=s+xe2Q5V9X6hCf5TmUh5H^#lCcc@J76Ip%Y76?Hvkk}dJs zs2>FJ_fsH!Pdf5IT<@7njNujNtqKzZ{9QoaHTK-MG_W-&_`!2~eoqXA=Ct$!pZBlH z7efiyb92??U9hvA`S-h8z82fG^$8ID6RpNbh}>n7Fo+2Vv*lQ}hDy z=ZQg{v&xz(T-sm7oc@r}*O=i?u-}ThK6_Xgh*e0i{}XMpM$SWB@=olO4TawmLk)7v zdl&HvR>3Y@+W9{H<8};BZ@-@JD1L7I^Zp~4ZLaqP_)UM~M19n6GqN(zi^6X(=sh$r z-D&X4coEz-m-EAkfv)9x48ni5A6nuIQRkXL43bM5zm07>eX~IJYnG0^pUXRbs0+M$ zy#T)jB==uFueLEuU4H)qo+mBT`aQY#WM(YI7XwSbg~yBEj$tcput5GBmX7pOUi`o) z_q4UB%igXKcKbcA#+*fqne@n@GAI>(RzS9VZ zq0oHri=i3VU+TrXSK92_QqT7Y#bB3prss5bG}L#Df?YWL%Y0abdQtt*b^p7$9^Veq zdF$`2D+T+({$yR%XsWj4cPLg2Vb-N7{m{E3H)ibdUTCgL-uDmS>@u9JD;c{_KNKAU zzT>vBbB)Y5R|Wf?Q-_v2gDJc>DAO~QQu+aNb_;WWd(DS|n`>Yg?D{)D^Nn3@&nmgR z5MD$KdjDfRe|r?zxt2?QWnC98>%0D*W-wVd?cZwRY@2UR3x0Y2v(w-goPwMEA#FRD zTjYJ(-w%Z72f;7T|9AP|x3TMS2APZYUZ6k>h49wAOPxs==! z1HWq|{vm@?)*t46ooSmf*d=cg1D-`JM12(aUp81}{M=@)^F zhX3c``_s>|4nAYC6CVp=khAFgt}TgKL%q?r;2HWQf7h5r7w#`(0Oi&d8RA0mh1~Eg#W!#qm!x;|A*xqbyW@i zUn|n=Zo>a%WvU%FjVDKG@C;5`8MO0y%sHxmA6KJVenQ=?^(R$>w&$t^+CGG`{?gT1 s|CvY@&zO_NCwK+F#N#?9&Sn$$QIm&Jlb5q5Pv=bD_)!+((&df(KN;7D(EtDd literal 0 HcmV?d00001 diff --git a/img/logo.pdn b/img/logo.pdn new file mode 100644 index 0000000000000000000000000000000000000000..70ad16af7f69b3ad59106c0e05c05892243dce8c GIT binary patch literal 23734 zcmd?Q3HZ}gx-br-vbmrGxQwGe#2FQ z-gC}--u-=>3MRbgTsUC7QLK>~FO^2Om7*n27~^rd#*CIriX>YwauuMcQ`3fGY=FU}1V%b;mvWZ;DR}SKaBXT@k|GG{wRMsYDe>C!>neG&@SnmuPlk?XKQvcY`QNwNNxh#*~FL*hnh0eQPbA^?nb-RXmTvwf&+Te_yE5Tk%cuuMt~Ih~!nr9q}Q7E4#N=|DFtvuMPEJuXkor$~_+V#_tnvI5y6*N|mM z*YG3*!I@I5D;jplFELC3jZsOp-F0>#y2x2FBh{-4PUoF$QRzSx#UNXAv|avWX_a3LbphH0S`l|@*>16Vud%TN)`)J6&&- zPd9^w09Os-xJz}lGXy3oAu>}fHsfqCUrG5AMk7$Js<6;a}B@Az>*O}+HD^=Js<9sJS~QD73*zRyX$YK zSxZC$6$PURN0Ub*sj@S`HghHuc4vhuWm}$rMa5MNb_prT zSpH-_qPOB!9Ck|;nT!@~*iNHeM^Y#lHBTZ!RP|^#jRZ9}o$)xyG!~>tJcw4AmM2pS zb!imt7#-QKC~*=BJ4%RYTSZA@uvkkAl(>j5>2}!;zrmLDkVZ>Ngl0u&3$J$^q=*K^ zre;$ef3O@<%QO(XCX*(hx`xV>r2zJY1Tk)veesS`4g zvvfPoqLdv<3Py@&6a{O*u})Bml>=@q*o8@lmgDkCm7*m&SkL1zti>fG9G2+{EYYU< zOsN@dOJtJq`D9mBbMSH^mqF69f=U$+sswaTfX$?f^{T3pQbp|q8>A94szMuz0KVn{ zbNVH{mQNsZJ5>(kS+8soMTk%Z2+k29G!qTCyG$q?(gCxOQOXl6i*n4|{~J6D!*qRijI=<}SKzGg{Y!X`S>J1Mx<~$yVKPTS(wQ z))!?h(sDLo9KsT%f=3ONt6)8xUqQ)sG!=IE8lIBdXyk-wOF@cBu$nfZ)11Ih<6s^&-_O9OSwjoT=oA{PnYJz=Kp5-1n6zvOmtbCUPCr^Hz{LnYM-j!G#bpS<+Z>G&8bZQKzKRD~nhUZXB`jD<)&exH;bF8}?KbloNlPv@ zg0`~WNIIFK6Ri~Lg>1K3FX^c)t>C!qjZ;KCZ#%$(MNAWt4uE@iqUx(;)c~XUfG6`&3gy|LMB%|m z2Wz0tngR(9Ay2@bRyeN0(NwnvSKwN?kcy?#ao9viCQ)E% zK;VH+!pD^usMKT#g2rM-J{hgJ-G1KX?@$z0tLeDQa0*Vn9jf?K1rqfIT7vEOXUdIO zBi_t8LK#<5&g$Vr8PIw_mQt-++vO*{T|Dncx^~g$Q(25a*`91`6i_LslS#xfbzZ=_ z0gmXltTLNUvXIZA+eO*Tz;M9Hl`C+gq57x*Vs`j^%0pT$GZ^3y!mCmX%P;8!NF)I;v141mp z<{d&V4_htE6*G&LhnDbUINQbKcoi3-CS1Ua`D8;VbktBQ@KF|fWz%+YGs*n;jS>m7RfNt;mEe6xGAq6@|9w~ z0vck9a+~H_F~f$P1vHu?3P>Z|jRdq>v65i@9bM!UfluM>Y+J%zQa;_VqXa8(!B*9e zAe6*;F&NSiRxOt~x#UkG?z#~Iwk_hUG|C|p4iqajp3gV@0X}7P%^a&I8YF6w1mTO* zg?Kp{Y^544zm)KH=%fT$4BHBZIkHhsTX>^b3NorerBW@EODn+a(}f}{2hoD+V$*~j zB%-lKAg&gju~b2?>#;57iGLEn(RO_%lF-2NoQ(ywIPA8>_#h7gJnVQ6U@)%NbF2psi9#Zfss%y3!CfsV!n=81>BE&_KP}RrQr97@gGE$3ax!tB4t9H80 zSk=xF5@oT)LeOwT!8u443PlJcPD;%Z?#lY)089{Jp~;$6Z#`Tx87tF>VktE#qyvRg z&@9LW%MnO=5?wRn=Mn^g7H~C5$$4Opx^j(<4>(+vMy_NfSv%{4LWq^k*)3C#1qmK= zW3FVSaCht!~)W^##6CzpXt zmr!nq3Y;-rxVxaIo&L7nxAs2Py#YPM!Pw>C;KE_OFJq|kwPm8f<+U#y0h(d zH31b;Y&gn987AU)T6WZIS;MZhqMn#vGpTEgpWkY$2?D6Ka$9gFUy zV+>7Jh-QGV7u{I7?I&s_MqxSzsf7fjjwh(1M9JxhTQW4oLBJtS%K{7=X&9#Cu%JX~ zqaKRlrD!mhVI2ajYc0jDCj|%WYrouLMx>E4aUJqMyy*cXUh@1>k$OlLGi2|ZO{e2 zTaBWM?#owM+Q>)^8m%HpS4qtknE-IRJvCqm%1|-JCB$l!)#O|(S)E zw1#_>0-ej3RV`XC&=Mh_1;Z>Sfn(SWx1|JB#O++RrJ=NpOQ{^;t)x6n4-?{D37@A# zdfjoE1on-J7YV&>X0y1fPUDealnoSOq)%$Hg`(Fih&e8l)dHDDRj!>?BR0oS?v#BzSYVEG%Qv@Pd2`BT8K$`c2 zLXav~1kqKMi;OCFJ*{{RxU?bx_7KAjisTR(E;~(UJ5kRN894xTG94xZw8birnZz`eDM$tsNMyLS%AyRS7+5!7j#J4_EoxPP;xW8VN6u5C5{Z&#g@d9Am-AV_ z=FU_Rx|kA`utR7B41+gOmTJckPaeueqHM}6n2fj6kqyak6Kbr~LU7p+Vhwn#obG^d zRih3!coqv}ow2-w%W+i}Rojy4W;raPJK&7R3N^A&6xLE?f@lFOSHlr!oOd>ujE_YW z*r2+;x+zD2Pb+DFhKgK@(z_0SOw)oi+3A=uGhiV(M34&|53TsEhzU1aVQ(YGYF*5i zCK5G<2EHWPrGeeXReae%J}E}snP3%-xzdzdZhMdd8==551D1yPy`hA+k<*gCTHW;H zRaM62KrUz#c!tEokuXbJWe6#G@Ds0GOW4V^r44}Z#!<-e{Nb(})kA;CY3BZ+XJgxD;LRWK_yn(7g zslIxGOKM_`b+xSsisX_)B$i9o2nkc^Oq2{GR3sm7wW}c>rtn;~Dz-x?1xdKTW+<}j zK#??3_d=Z-PU3lYUKN~$R!U5J$^`=Q=a~eVV4JL9rCgPy%US5ci7XpT$-v2iUB!xM z#{G$8GwOt`CMUY+ojT%=5mniXrfr?Cq(H3JmO{Yuk9EBPspM$`hs0znw5`ix zJXBBDDpjPbCzFzcWTGu+H0CM=x`34%wC$>=Q&_T$|kd9J?RvpSW^Iaj^Z`FPBWdnqmDOB5FTcOdNvqMa-3bn zo8fjiUhUeIXvon3mT7_o_D`Fu<*Tv)UMN_GI~mqv?Qjta6pKhf_GkEV2qC4k z<;f()gyo24VugGj9KIgcBAAbJ2dz#zVQ@8p3S>&0Rfu~v$Z2^Rf!*Q7_~INM6CCemMxW;@O500r?P?>lTwH zUGrcC#A(FDwCU#z2)J%}4(qVEWWW(Q6c8<-v(sp><17HbIiVnRh6*F74As+NJ?>Fx z#)AUON%Q7RsOHvSEny0j9?_hro&sNupDV2Ww%1OIT+6?X*%hRmw~4oFLH<) zPS!&$5Im$k<#3~0!Vz5nJXUmi^twm^ffS_04(H>6K2p5}n!$@<*-?(LokqUxmHiDg zMEkRnU&=&MLO}>)O(KjGD~M5Zm4$jGpg}$XkX6d-Y(Q$DnGYZ|@MnrvI-SRJYKW4` zc+<)QVT-bOK3p!BW6m}bBV!s&1NGamLIFvy5Gg4@1dy;HvMgzs)q>%2Na32or@LVj ziWzY%U-j2xkPI9>2gCcEI$Og$kb-j|3@Vy29wl&^2v&VcunI!*AOIh+3i(()B12|} zsTD#jBE}P8z{R09iLjO&i3CD`ud9lVp&C|G9jwcphnt0J3#ytitV9+lpz{LlaI+8% zCGA`pk9pL364OhI8KY~@E zZk?%+X$jC4UZOD%n~Hg1eQ{imet`S1Z?~A45?*_dLv5HFy5(pl`2Nd zXswfgx;f2-aJ-YWjBJwzghdy;gtyd6yU{2fi^$D#DV&MxRL%^sR)rx|Ii8mVJ{rhJ zT$E%q(}sjVa>-(vM2@78R2uB8S=C$-hrffg>y`>9f+hun+(H9{uc>5|;|xDeQZn20 zWhw?&glY-0u4W;It!Si@XQ~-j%!nm{-bX1FEduq^f!tCZb*fE5i?vmxk|A|G5lpz; zQ8va=b=FixE#%X)6q7*WL_G@{B!MU@Pha7B4CBG+`q47Al? z5o(liFIVMi8K!~i9vZ8Oss@0iH72KrfOSHq1*zWXcyU~{89e7F+_`QW5M7&RSzQP6 zC#;ITaJ~-MxSDNPd=_u%k%Fx^Q*cx-wiO3%&^}L0^ar9K22Um%P>{+?HQPemOpJ!J z1xf{*ld3A^j75xuE6eLOpw9)R9`_qzZz5A?*@Q0SOAN@jdAdc9+N>%L6>$;3$K(PT zy6#53V!Ot5@-!ryR>5xOJP?B#4VR3`9Y1V~0vs)6e6a56geXPHo0JqRg}iVh$`ZO= zYa(ugM2&8iDVauqqiPX811Cj^#@RfGmL|$r!0$FeO0R^Je6Dn{;3~SDQlicoQh||d zjLeIOtBP_kr(0;;Ml>Q`bs=ptDEml-z<}P&If5Wl!m@GIZ{jVl?FyE|9ymd>HQY_e zR@*Fa873MsvcYp;yG%OEfv6|lb{AL<)jEb2l}IF&B7mnM zXOMb;EgDFXEvjLRbXRa7e5;~rsf346bSwG5H)8fjFlDrkbUxN20B z2qd3FgB8K@)zjXhQlMg926C}3tSH$^Ljulxn#{RyM0Eo_Q;LCnubK=C0Y$+0ZmC=L zrsP~UOT?R^9(Jh|qz7FUBF3f}8G}MVXSUN3#&X!5q}i<{Z8mI|gXOrRC!LCXEhGiu zY_N#>C~)@fM3ZTBbB0n8+zFSTA?tWjwpE7pqg2?#6{7?SqB$%bO69s92@`7BT12v< zSvd?CT|ha-Eyr+MDVJ!60eP@oEGAM?BndqD5DjBgR1&PHsCi1FI|XVLL>&^is%&8G zrWh!KauZ-{2mNAH4|5>T2-k}--5Y3^>Y)M`ERhIE`~`rJ*HLdV5L4x#Tt`57OkveZ z+bfy{U9F0BCvcb9IIj|f&DJAI+)?!a-ONcf5kVbYHbFsFB81ZlEk_Na>&hE$AsSK9 zkltW(dcn_Pm6qBLCkPeF=gK}p0_o_SsKpJRUB`tylk3JZ*`932a~Q%(z-lQ}y1tBV z1~t1ES;Vt7kl-RcK-RG$WGbB!=ggI)NE@t3$;FL=Ot=yxqrvHfm=%D*j>s8j8sXhW z5=~UFmeY`E;0Tz0mevC$BNfMKEg0lLK-NQMkhmvK6P8btqq#;lmC9H0hJ(}e1nUJ! z(sa{7RswdqohryyhwMg_wvfq2f|62uH@zXg<19hzK3Agi>A~?u(~t0$k5@h+r5~q9HF| zW(hOO7Il9RMU#1$066R9L*0(YtXIVbh>C;2JmJ-309bE^1-9)^%QcK)tHm1RB!0v$G_isgKwj<{VCh}_U#XWMiptU9d5YgEyaRH5kc)RaaHVT;~`lrbW(*UH7n zf|GDFYN4Vxk$kBY?l`hFOhdbD+pxolc0y=nqdIU8(U{*As%q7|7)s>qbSeERFOrU z=@6+m>m-Qj0CQfEF;Yi?)*>2F0eD`e4jqrliDXi>ffXIDvv8Ea;tGVxQdJVwNW^Eh5*0gGRj~$}4Uv@;o6Fdy%!42ojn`4L z-YSrO188*EY7BrN4Mun*?2ZbmE+Qd1?{*fVcoB|iktpJB1H;`W zgJ~rIO4~HamCGXuSu{g(Q_$3qp33B#LMYSJA_)fuD%(s~ED~c=ow(xl6C4>M(4fOn zBsm$=+#FV~DMSTVseIEb22na1$y#up1m`B`z_+QgfHKKYJRcBQcdbcvpcI!bm-CUX z+h}PX;4i_TI!6g&!G09>wIOXq-;xvbr9V?N~BMsJWys0OCUlsy9Z`LL4R*svs}N=q&~Wzq~-5 zRT?x|4;T~{gR8oUtH65mfgniUXXN??))V0Ns0`|a4!AMwD zT|s{wrl}HGGYn&plC>#+4G{w-Wi-?b2a&22V@j2n5%#DlKA5n0yOb(x*{-k1sZl=z z)>{jK3Kg2LO;dGqekvAD3Lxg1AzeyJ&nIK`c)1PotDFo2e-#fyhSd~;kXk?xHetEC zMG#1=0ort9ItB4ap%L(i+2fk(s*c}E<@(m+`#2s*$De#CJkzB44g@aNGJQZ~{ zij`iFT9mb_*ljZfuT+g%-fAaMu)!HH#cY7Gxu~5EA|U4r)2PN06{aUkIh-}S2pGyj zYPVL#t5{G(l38ay!Ta3hC`zz&ElT5DEm8z*!w2MAfI~ep$~a&&@3aN7Y1Ax@ZvX&j zfsAM|GRTBgxLeD(+#pI%6eCEMNHs85HV$eeK>nvg2RkLBqD2)hZ#da1=_M!g-9RQ(>n;ltDtzt(i24XctRxHHpKTRcKXnNy`Y~cmZW=)hJWnPlC;IboO!NdkyK^7TX!?PNG3WYdXoup6XWS_0S*5h=Jt!Ql;rC zIeAe8X;ToFjMR9rS<4rX`yFi80I5S-O46Z>;xaL}E_k|OiEoLyq{E9_9H0|l%?y%A zE7Z}dj9KvcA%PJQkHV2b4X@U7aS*mdU5&6%r4`n3ZpV+QVKAG0Jk8BohTu zF_N4xX0)?^yz?Ig%+7z*M)waG2>uNia2R}g-@VUqKLJf5#Va){s9TAWH7>|o`~{=` zQ5g-51EtYkH!==#xjdc=M&r$@)ig^JYNe)S^3@AQrF}T31W83AJXmdQ1=a z$bW&Ug95oy%^CzA3{x6GrD5oeQgP7tHQC1;so5U%eYN(`e=p8Hso5x*@sh-tIZMsXI|!+H0g(-tYs=S>4MQ(L)1a4Tlg_DT;ssM|1}l_pO1${7;y)@ zP|4*FOupd%B=E_TCigZ!VCYexdF_Y4p#WC{h8_c&V|us$bDZ_Y3<5bKa5N{PrpW^* ztzkK)C_Q8k|Iv+x(k=b;NB!3Kb@N99@c-#Ke}5Lec4&_lh7JZzZxy}e9NnArzdNQQ z>zESfE4n#oN?fV+zObfJEe@T+lv+x!MjyNcj(5nA-q0SX6(a`>$lNtxz~COtBV>K# z$;baC4*cl7fQA2SY_&&3N2#UGF|8h}4jedWD7Z1~7vR?q<#84-L4$^YesFxRKUyh* zUvjwMF{7(M5{+>qV@6vYqXd5cF=q6Uwcc=sW*8g(mr5J$w#(HH&?=5zdL?$p0e+oQP=KYoM# zei=P%3>-4#tRFx6e)1#jzXCWS{Z0jM3_T4r|CGx=>jCMZ_z12~2Ny$s4w`=sI0JMB z_RxQ1z?tA;Xdh_)IbbyC9MgmR|7=%1Njz8pG*L_%N1yZKJ#awLV&6Xi-j;4^eD#NJ zZxcs0a#nB7-bVg2y!1%tUzGTu2GF6!(lHH@uerd(qk-W5mm`mtG~MiARb5njNbUXo zLvf7;(tYTd9>gA|{@1wfk<8IGUMu}adtq=-b$}for!+8LR3%ey){295gBKO6GxP{5 z;(D<(u%}Os{;y&x3>^5ApZ)mokC5(>i>wedvrAf@RelA2sBjY8>u6v){tVUTr$m45j-9`aA1%42h@K+)xg0$ zL?5wddf!L=*HH2Udt}kW{=gm;^icXwgbeJR?~!M{fT@MeqzmtO~VHL`npxfBmeh)<_?AyzA1jc=bkV<@;Pn5k2W;#*e5k^ z@~fM_{{4eXJ|461uk26L!4sL^{(cMw-H=ZI^ePO$^y+k>a9n+M=J!d@sIPA1^UCnQ z4!&XTYnMLo@LBS#OUK54Io9j?`lWXcezocSse$c__gtbL+S7mFu0zwsX*27CrG<;P zT=LDN#+t+GrR~?xymPX2#{x+-a7S?Nqt+!|IfQmti5g8 zhNWx0tGW2Lm!UhA>9>`=j}3pb`oJ#!j@3{0$DX+ToBM~qe48)VcjX($ZF|{u2S5GP zkaxlGm*rQfbyqc|*y-!8;-Q!KyRI$&$01kl;!j=uc>i(pPy5lJH?O$=!eRH!TOpm? zU(NsQ&wqcs|ACpFyYFFb^`{FR>aoie{))S+x!XVY*@JD ziI;~RCIZjQ-+9WhPbc)(uBG359N+xPoK4sHPT2vkZtK&ZTzRxson&j9+c$pu)ho-V zzj^wiwfEf24ZVJr^Eac>kUg?!IyN&c@NRw7C=B_T9Muvq`h&F6!TLUH
                        7&^guTO1W$PdRa%cOiQIjuyhFF(-y#Ki= zQ%>J{z4P1`rtFkv4Q^ll>8LCJwr=pr8}D8}!*}wTx58&Gn7iYh?B1DEZrWR0^zxE> zcV0fPuX_x}|Mf4+C(qLF9sbzd&pw;K<+)GJ7=Pc+Wg|9yF~wY+7{25;^m|L5Hn;vR zIr8q@Go4Lte!BI1>$3wF9y?>gSM$E!FqPY!n0KZCh?D0JdH8AD`V)BjKetO`vC9C(}_DKJ0Lti*+-@MH;rtF=*k2&va z<#O)XO=CXH7FI5u)W^N|A~FNrJmZ|DP6OK(at;}}^mj87JHA}Ek6jnOxxeL{c9Xg1 z+QavAnW<-uxcatN=Kf;0@5OcRSMFK*>HdfIP5eEN;Rc9Sg_wRr4l&>%PWXnm9e|hnu){mvRb8qdByfL`7chv{- zuUCIPd);+k41DFHPsV(*fcv+VZ{P98{#5-OEHjUI@n_qH4{JZ&f5*Z}-&{Ov@}8sS zd^zZMgBNEXeCcl|UG09gbJ}V38BdR0ch&Q2K7Du2&_f%3yLIEp^_{tooaSA(GB^Fi zzux`q?qeoCc-nypBNw?JbZot3;F?J`x%rT^_uyK}-VsNu?|2u?-MHUBVc!eCduQi} zJL<7H!o0oWU*^nx_Sv2L?%>ZDI_tvGZ~Bh?Q|gsx&+37^6)Ydc=pIn z_}sA%UXC=MSUc_m{#EU@C%^ekd*qG@$_Kf=>)yL;!+|$GZhw8}lAA6)>W@c_>|Y}e z+jQ%{4ccgW*U#TO?!e58uRT_{VEx2zFPhKN=gzZp2Tz&)_0~-f zKQ#93&ki2*$|bLM=kEQWa`D|CUh;R}E_(-k*|_nq?U(mF|I+h+y=d9AA+K_dd!7(3 znDDFmIi7td&Rh2GCr?j3d1<<@h|uKjq=uVRB5ok!v4m+LQGdYe5vI;`)}o%tR2-|`VlpYmJ( zq2$9;#=raaOzEM!*NznLJTUQ@opY{ky#1$2CfF0>RXYHw%%zw0h z{nM%W!iVD@I(6;d$?L{$S+@23EoUx$_pWn)d(RDDU3y0J-iNl`k)JVg=W2P?*xqtK zn)CXXzxM9F`-2Cxs~5jEeC)c{_HOv{%!9X1JL~hm{CVPit#dkOd@4)V%^8|m|LE(V zZTaAvu793vDK%~`ZtSaqMW&arC5smbZW*6?tN$c{m}^z#or%!puXnX+l%UlhrhXS>7|Qy^Dq4B z!u!quGb}z~+s~){cJjd?^5>0NTUB!V&BDas_5JnywZ1hkVaq<+{@SP4?fdP)J06+- z?%(?te!6q}N57i3yRdEkcfP;e^YT{#-=D~zy}Dd{YuumiTok!}eE(0@ykXzHeC3=& z*TBOY!}`B%KYVBZ-s2Z#SN!e6Yt|S3z?&;xzmV6jSiSIz4_4@V7Hl5@eRuGLwf!fo zXu|7W`E&n{`NwaZT0WkB^}=n}R%TqWe4=r;;Cz4grQ1*1+wx`(KeSUCx#+Y7;^Pm0 z_tbN5hr?6*GAqvU3_t14D_%Ht*_uJbr5m4qd*hzj$&Vg7`Ow!-_Tav?cH;W|4;{Ep zxbDupcjltKufB(j-TldWY|2EtJ^7{nQzs4IHe+4;t=le}xb~8DrNb{B{A$rl&D-wz zE_B1OU&nVnaY`fp^>vSKfBS0x#|!s7v+2Bh_uNp=U3353JC<>Kmwq>4(U+&qzxBy~ z8@ws9=9N$0zvt#}ejQqN|7#N;+@hayc;B8u8aiV8n@n4A&<>H z@afF=61Q)C=<5yri@)CR#8b=XqCe+bk8SD<>Wt;2J?9JT#+#?j5Jo)pc>g2cqT|C` z_Mg0L&zzgTJhN~4=BvjqTky^C*`KUGyFTue)>Dg?o;Yju1@903%{)MaZw`hBd6#Wi za^P&ou9ueHwf>~)lke_Z_swzBX6=pp?@_n+Pv$2+>)H3+ThG7$xBUr2M(`))7t^q>20A^O&*&t3Ondck9}7p`7&aenA! z7tWb?Yn?hX`_Y-fKg_-Lmz(;gu79mCaox)4-`1Zsx4p3L^O<(`bKkTJzuM>+y6UVI zzoVr;y3dT>FruM+{ldhvw$0DVwu$_= zUwwARQ|EoC?x9zmy`4SH@z$i^l=Uyp?wqxBe)PD%kN@?q5uMR{Z+U1&^o#>*&)c5a z{`Bh`mhV~lolsr#*n+ul-#>i2hm)quqBdNJ&Hm)oTN9J-9x>{U{K8Y&Yu!tq-+t5V znZowfHLOM_pndr=8pRMn1{pIU4!;rv*J-!ofY`WWbY}vAKA3{ z{zL1+$2@TV@TITc{?Yl9`{v*K+Cb@xrOU>Ie{;$EtNeeZFWWJC>9vQBYW!^JHEX`X zu6e4^Hww&q%PSLaJLZ);u07TG`q8p`#)-$yocNQ&tKV7+)2rq=W3{Vx(fjuNW$v;M zm%P=SgWrGB)h`TF$1UA@PqO;5-*r_gJZte8?g4M!eenaEC$6krHvO&7K05d2Ni!Fm z-@nK?vVY{~m(lFiUF?Z(y`JQvz8Q}!Kj-GB-Z}M+HOi+S6$0NqlIeSQU*GA_C*JuZ z)f2YA_|^rRuSKhmJn`h76V&7A1DnI}E1e+y(bk(^U;E|W6@OWlT|c=N-9B|1KX>)d z&%P5|-#mBb$D6;paLNf&hWzXgwevbZ|8{eF&A`7|AHM(ab=&vuzG(Vo&O;Sp z(-Si$oZYzgxIe7F=9>wx>{<1$@9A^<+u78CSzm=F{Nem%@?Vjg@LjijEPZ!OV8-K_ zzN^k(Iy3*`tKHg`Q%}P-PkjJc{iVGBsSl7BCr0MspG!~o59YBuK?(jntFhIAZSxa- zZ=Jqs!HiiKZvW%$;?d{repsIQUf+rpYuUu8rBf?AFFSU{xi@}x`uJdA>v^?d73{go z$$9-d_33UPs~p>&cy;Av*PeI}v1HITW8H72FMjFrS+`wr{MEZIyK>!Z-%Hnr)|{f= z_xnT7J-}{SxoctJ;PlTP9e&Q9!&7fIHa;pWyW)&nf7V)W)Z*R#4@rG)c*IGpKpLpUNHBD{d=$b_`3%$O>)O?87j`~ z%-q|*`=*a)7vFt&{qrZ@`g-?^pTDwiO#az(SH#Q*&P9H^anZTM4t#Y6x%PpV7N4-V z|MMC1A7bwuy6z}$*T9w69=rXSw=Q3PIJ|0FW_t3&e|z0~)&sxu^IOglp7w}C*7rS@ zUE9z{eKl|`HErClroH@KPX&$)RBxB3_piCJ{?c<-``1g3rC;oQ^@%Mfd_Ly!%*9os zPtd;l;|IU9heNaD*EFWh{_G2@_1yAH_q<82g^mua?ms;L75(=!z8md6=fU=ABWBjG zNN)e^>c!(X?OIU(>)i*>zWRlP-LT-xeLELCdBfC!uUvZD zv`g1~vugdL^RL@{`&~(9#lENhTpDX$<5iz~+`0TrDRu!a^IXU2O70EPkQY1 zXW!kk^88JWgSl;^w%ynN&5%t-b^T41QNmgb_w9P-l*?lC!)ura`j2f0?=K$J*#FVg z{*}ySgU44s@aLfEZ+(}bS2{<$wfV7&1{YWDz4z{+{lnI+x=UZTYtq#d2Tk2^|3w$A zSpCEU&lWapyXen*K3sDB6QjO4N%B9r`-=0Hp7d^K@%VQx`rect{^xZYe!c6vV;(!b zv#IX+cIMw#zU)kHxbZ#v#P{%nua#yU$Zi~dV1P8vxRSp!aLo%pl`gAiHc!~?-nH}i z^R2~8Upb`yYRQYWb>XKsjWw_HpkF-r`z1qOdFG6DmlSJ{y!-q|zRj1syz*gFU$Fks zCk~%ge&L*jKYfgO^S3WdoI2&h2~$^II`-SQ+w-0t`>CV4`u#%RhRd`2cW`sQJnFJL zFL|fEpgQc8JFf9g-+9H{Z%#i!3-5iWmA%IO=;M3-JolGZwLZ9O|Av<)ytYzw&O7bt zsktvVF7xG_ce|D2F1WA1GUHLdZ~Tb6O4DMS7X5kb$f-xadSJLi*x-}DUHaSl0pyjX zk32T7^UMSDpE`72-*Jauz4f*Hr|a+QyZ^WLe=FWhqmt0p23&cvJZ5O+$(d7J%hCol zoW+XL$~hczNK{k|a6l4Aw7lhz8kuv>LphU=`#$fx2Q-I5Etl(FQUU9IS7&>LN_BuKT#0^PZUR^yyze^q za3Dfs+VO#B2|&A-8>)slsKLbLhqNsb^PznOgx2MohRMdMe064}-O;$NTXS-qM^?>u zgpmY|km#>crgJfwY*_=^t@!}`TyKgw?%P&B!Ag~+sRXyGj!#D?`Z9vNQ-3E@DYN@kCJFRywb5m% z-unLj=Q5!#dsNJ99f7{6aPpxx+Hc1GL-oprzZ5rb9FkSwX8k)`1A+OYS$aHIK6RiC zb@MN9Ki8jZCkG94{EKlNv>X-eyDhc!m{|QwgS?dfjVE+k6P4wB*XdQ{p6XqH=(YhP zQSw~Jso%tT_>N1<8Tlc!;jd8>yBw~v2O*XEX8sU#v3twq0) ztJT_I+8lKqHAQmKTD#PQb}OC?km%;4xIUQ&I43=<`@e_-`yWe6`7Pm7?1rG;2YknR zK&JZwIa;!4 zokEbSjZG-%76yWoLLt}y!j2`q!!5x-P9`0tA1HwZG#G;s)P?A@1pe?fASopUHt2qk z;sT=kaOmmq_gZ3XW%+5>W5rDW!e4af=~xw#>C_itUK2j+dg73-?g*;?h2jBGJ1$q( zm++!J=V+oRdY-NrTW3O_^bB$+tid_^ZYSj4RtNn;OecJO^%=cm>cFWsDHr8KQC=fq zeFOYI@!aHw*>}Rgc=O9YQIaodXc?41=S97%0@7ydMgU7`tsCD232T_R2tsOhLg@$Q zrcX&qGlqWl_r$%Ai>pW0 zY_E5rczY*-nkb=8%m?6|NH;%b({fGJ_}4O5twRtZ_n=6=VDvIdfjadYw}RcQ$S=@m z?1pQ_X8jSk-|>eh<8y6&^-io=+(9y*QX66r(Fdkzu8 z;aKT|T$WC|IkpbK`}w!_-Un^fZd@1!J|a{>Q&3Xeifw-L>g4pmOC4I-Wcm6#@(wK& zz_IoFBeD-q)#$%`mA&r@Z?RF}$wjmX199wIEdap<^s4!b2;}CXs^P91J1UOq*Jb3nN0EU_-&s3HOPJl0$~qO`tz2JP1{99 zQMB=>uE)nI?VKfj3QmA4&flcbXnDVkn3C|ux}632Ga{x-z8i8PcTe8Qtow+OoEo0` z$`HF5%?K(Iorm2b8M(Vf+I+S$MI;87JQH*h_Q=n$pMo)#YinE2_9nN12g0lv#2Kqui^mWkf7a6-E zABbkO+x#mq5MRqJ2g~B&m4U0`Cp!T6eXY2{S`PzZzttpg6E+lO`xyc2GVoS%5mAJ_ ze&b&Zfv?icLT0ZoGWPB(hl#k^=@-@%^w-*j@fSaj*TA(u5o38|R|DxmE2LT@(^UEG zZAX&WIiHx9(KYH4wsaWA@}q{4yEYRYfBK*_EVKkbvu#tM}RBZJPtwA@72d4LJv zc_xsF99msGJj2_iG|mf;g1{1QV5&xhq8zghOGy(grNtb+Rv`O7~oOp8kMDJc{k<^h76P zan%~wZ_ zkI6MBF7wFCu|58w^+)i%3aYqp(OL3*&qzkCAonQnm=QxBiue53fQ-)NaU)M_|Mi*u zJxok+jq!s96$wqX4=n~pV;&Y+gU{0^*L_AfX8aDCHc%G?Pwdt;v57w-^4#DHMV$*- z8I1a=!(kl67lB6f(m8*>Y=13($Os41%u&Pna7tqv@II^CyDXstec3{fuB9x6c9-eL zKR2g!K~>ry`}ABh{8ABsA3;JIFvr6kAWj}?Mi%JGdBIKi?GJqgyrq~A$b|(TWw$^o zfhzjBMf9m5??#bL0uZS=s~twckJ6=+m5r_AH#kLlYdJzsx+dtjJL@^4B?lp%9l+yH z0dv=FX7Hob#T5)|3O6?Y?z=+M`fhtVd)v4wjg&%7-QPDvT};I9_Zi)E0CH-ALTSBK zSYRsVoWoCG{9~r9owA#`fdM{U$g;2i^5Y}TT0E~pd<~YO+db4;>y~1hGW#tl<7|uI z+}Cs23jBy$TCrZv8%Q_vVN)P>+%Pf#`tb!FHGh}u=VOWYtQ$p*W2;?X>y>ZO&MXfl zF2zo>7D3S1EyUf8ElV}SKIyIFe$+Vfu!tXCl{OZUb>?Jn$vsj)D{3sZ2l0|@vJyhl zE=J1SzIO@S6SqEnQ$$%GL(msoC;_@BFD9t?T5MLA3O16Msi@;ltuDIPE)Ie(nO42D zft;)si)+48Q0sL!E0n-xQz|oZ?+KfyKhAoIVDO>mU3V|se}YPWGE|nSex|luP}Nx+ zydHIY--!_?Xkl^$&wjmiC36O67kUs?djy|PM)S@D%(}3Oof&OV{dXPI3G4WX| zXCr=xec3aW@(3Qeh+xGrN9}p)9ub)6a6t~sp%tZ?h&V^u1t}f`=wQSBmlt_|k8t-7 z$`_)OU8H0hw|u|~WK8u6aFng?ClxOH5Zn_hHVY1k@|!)}bT=yjCMQ|dMO>!vRSM?M z=D!`F-v^R}B4>i9>NUFSo!a|H(8*q#$rDbwyF0DrVKz$TiC;2^c!4I<%RF@ji6#fMgri6f9)JWX9iAe{qKD6ad7_B2)a5 zQ8vbV#Kr}xlL;{I^!glim)qiV$<_(FlnoHmm_ZXQgPN*J;Ve{g<~($Rr-H-vNk1vS z0WH)5O75MPo~?4}ndBoVVI)M777a+UWMOBHKe|?xSl!Z;39z*v7LVdzYxCE3*1Q+? iCCHP9OD8B&4AKAjRQ&J5{@;l$>G2*4whg}ooBsj#1L3Fu literal 0 HcmV?d00001 diff --git a/img/logo.png b/img/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..32942ab6537fd091b05ac62ff27d61acab0cf48a GIT binary patch literal 9010 zcmZ{qbzBtR_y1v+C6)$BrMp8Aq`O@?vjw&IP7K(v^L8z{#WB~mC{=Gy`XslAk8UN2nj zy%1I&b{K9}jxJvOE_PmwBK(5O+nwf&v zNF~lBsOm0&YEQO$Zlm$+)yCR`W#U@zDSS$1YwxUMyrjjmy=71A@@6Lc^+QSTPdjV$ zxzrMcw+P4e>zE0Bx&YDqXGI-;Z^+E49&8GEb#k%ZT&#Q}#Su-@Oib2Y^?*A=xAULm zk9*a-#JsfmsoZA^-+MPE{ref%&<@AwsBOELHq@!K>idgH0Y&b01Xvt#j|{3(fJZsfm)r1*L9?%Spv|4YRJVb2nJnBTX6o^_pbLrh5aT)SV?*w->HmRP23EAQ7rJFX_Oip4N7`vnL`1F znc7_@FuWK2@-SZ5uXG%eQ-;sYXphdkjhJ3>4LuGF;`aQ~56AP8hp<9;^Eq?djzZM# zhxF_`dhn9ms0`)E+7z0NNQ@B61A_Ol`gW#0*hy{t`9UB=-kW5W8R?Cglm%@!7L|N* zPh=5s)6aFYb!OjIvQfx*UVg_^-)HdR+WlPO`cHb~V_i_y*+U_EHdO`RXYq0V-WR0h z(`{Pde9>Tjd+XuP&tfJzIqe@{$Pg$RoZn`>k5thASaBuF_<l!3&+Lx0u?Z3#OubodreY0aT zCoPd?f)GgI>Nb)Y#D7)z09;Q@$@&WssYJ*$zE0|GQsHig0le49O(gS|qZ96Cz&2UW zb>i~dV)w7Jt|NYuvSB4PS`4qzy5+oX``0wnd%g1H#Hc!&qY2(K4;fdb=*0Nf<8|Lk zSsk~TO1uj?`VWLnrij>%auzojIG|HB7vqQkj$tASoDR>gA_{%TGs(_Y|Zs%0&zN_gRQ_ zvp8GQ?+x<=|LOLC96z&16E%C`1*f+vXHWBBdnmqHEHW&NW}1V`!||WLSPo+bfrNTb zi{ylUJM;yF1dhc$@fV6CEVc>6@4+jzPyZVnX}ulWLR!C8vx+XXjeCV=%s2%LV4FW5 zYNw2pH+1TAwM3rFtdaY2reCHQ6Tnd)c#0VdV^Rxu@U+!%j0&SUn9!9HXraYz<)oAd z#4fp7=K1LbrKS)Snq%|!`AFjC)G=^L(S|d^4j+)mT0}ExFOoqf30-4D^ zNT;>%{(X-!3kCO3Qot^S4vqQ^e?;qf-=D?^qU6qwR|0^x&b1}*=~@%wdJGa}VT_|1RlhAo2+b|0jMemm(0 ze!*q9_2JMoQHYh27xyhq0fHNwm&;;yvvAYJITh5;3PX5=o zsUXoZ;ZLwuHyP5da3Jsc~?6SXRc@HrF*<=ES{=S3ZFDO<691=j*zj>AG;ma{%wpTDgpbYD#2@)_9{7O#BkT0HEsHL3#l9ZM?#Dxt62DelhnX0 z`jt83r%6U(H2h~0`S_%vj$GaG(!g5eWGt8pEWz#SCYv^LP5Y6p-Zr%jxk&KZFRvdi zy6Ro`Hil~dW62{Y6l-r)AzT<`seZFArS5?QTlbX9?1M23nPz`aj-|Oicxm58P8Ywq9T_Ak2 z1<4#pkwn&AXS#$$ku??~EG(AXv~0wZB!M*PF|9ImxooG>%& z%kOzE3Rsm1oorx#t#%0z)W$|;9kWEnG)ReP?`P|BaMzd+1PRrGH7RSBJwCs?0DHm2 z_RC{#`-fgy&P|t7cI$8~S+S>Wf3070?N^g;+8 zTo`|;V!P9?&mgPlSr92{l@RVHHnmni(2-Q{=~(WGhhRL!^!CPW{ zt^;Z9#Vbu}W}_`HA}I4%H}>|f_<65lTYWgY#$K~adM~HU`#;8BddosWB+HLt3#7SZIt@^SnFwAisL&6)6mCuz29%ta(+E8GCnwAS($W`mLZ zt-thrdpNJf2O|=|K|VE%xgAoAJCms4ebA^@u15oNBravG6-BxKS3;Wu@$NKNH; zICl`z{o0mYHY}>hbVvQxp*YTpnF@oOrr09zv>&g~e$dFZa?W6NhZ_i2qlSMw=vbSo z63?U5ml6pmg$H6HG50?Vn=M~4Tg%zu`tto`5_aDg=W@PXKkca@xUhVLPgxkuI76^* z3-Vd-P_x$h4;Mmy0#0N!=;zCWp?&V!o{r`rC23A4EF>#c_fbwHFuH}<(+Ul|>96ud z_}?wMNJ+uM_=;y@gq|NY9M$+p)CqNZcqn&u_hyQgF_bb>F@+~`22prQAu{c- zWTTBCac9RqV;Rj6HaZpd?CWHMlw@Es19q6(vwr+0tNgCmw@~J;1b(c{LojVPH5U4~ z{mmNTfF!-QgP#srg zRi{ydJgrtBv!;6Fe#I5HWEi-^`D1VjIWBCsN6N+vT|8M=7l;V63i+}0?WlJ2>iXH3 zZBmOi_XXti*@)OugZ67mqg43PwL3@9Jmos2^n*=;v@A&`swLVc#d_P7{*!oq+?_s= zA-I3e29~B;&}y^Ui-q6aPbb|}l}wyL@(06q`25CVFp#zbO{4BG4sVSy1Pn=T%i2Yv zHPYrW#3$RB9ah5TKl^9Y%*wDS&gXFcec4G*O}kU6x7z~i^x~@21B%n{1|08!v&@QL zxk!PVbf)Ms`(yO6f@0*3_ffjGfn%Sv4nS}Auy^xcX7-M~8-*qwYxK}`x$5Ar5qC>W3Vf z`H9G^`>2`jop!c-XOM93zR5x(dip9A!d>0_)l{eDu~jr(T3pT9v)R?=@Ofc>o>T9N zN4S*n8vC_dB{B^=!$m($v&;e-5}rCvazs*<*N6<2e_C=Z6uq2WNsnovFSM}bF~DuG zwkKM2^*|QZmHiN_HSm+3Ip8GZ&Css)pQ#GhD7q$?Mrr%C3hwCUR4W=fw!OaLL6yyUjDu3-G8%LQsWM@OgD6dFZH_PXuH->9kkX& zsoUvgGNqTQxqOz0_uT(VJzMpRxFM?UP?F&Uw|ro;;Bh;`eSy0ju(Bfx>?Rh@w#&m> zmj?|sDa(Y%rZ$IVhnA@3h!tR@>kd@Fbp}aPJwP5p zpF(UxUa&Ng(@}s;FcSf%Mp6P$8@^}Viauh&x#yDn2+s7l@3`#IVODMFq1Mf}ix3>b zSrpL)wyLm%;M9T?=rw^3)03%3owu9P1Q(wM6^&_OwI+2exivoqg<=oLKVf=rZ?veg zG{I8LI*qy?=C{9Z7B>dZ5}8XhGvMvMrFWl9U53f7u3u{_0KWV;4aeSP!G4Yel?~Gl zGD;!mQ<~70wNQWoVsH3zz>%-&_o}t-I?Zm+p5I{EnS|dAu~^FBV97`;w8CMC+RdnQ zH##DeDh5-K)OQ4+rbvxWRX2=g((uLaZek}aklXI7z|Jv831wth88t&1J3CZ}F#!C< z_4O20yDp@u8flr$(1TvGE7%5)zs zFXYYR#fs;*DLZrRgNG&3sWkQGGkoTr2s}Xv(Kgauh@Bc2ZH?9GX*t5xkG2Wx=B$$* znD?p8-O3-e+f(^Hc3H=o4E<|&f9oz1&#J_4zLHf2Nw#n%#iNv&FcIB!tq{?VI40M! zyp?)(8-)GoQKY4i3o(O=yy6p(C7dqW<9lw+eXbQsmzEpKoAG`+#Tp(NFLpuE}m{lwoFHKKg?X|Aw5XbUH$ z8532e!k*y%cs7~`!jm!2`uzl-z9{P$`yTqOtfV-w*5QMX$G1YGVA+f7r9wBJ)!RIw z{D?Z)OfflK0$eUA@5f|tw~LnhM@`4tbA45h2u!@CgLMj-i7XtgE&(#eU{S-1)7S>Q!G@d`^pR=neS2VvfT9y0h)I35kX?4V_hJFk!QX z>P5Z(;v2>Ff=24sp&#*=bM+o=|C+qw-8gP&F%Wa?=O0rycV6*;Z@su5|4|Ggx{i3EeUci& z)D(4fW|SonX8l5g2cIphy-k7F#)m`vCL+5t=mV4U#Z=nZjN4bfHsK!w+5)TLV}E6~ zN(91G|9qv;>+w&UACc}e)_KYaEk@s&^!t4V6|)55v16~kSvU#EA58HSC#U5e-j4R^ zCT2e4^ZCo>EQv%$NQ8w@1juy|Ovvr<1v`p%#(i}a*t4*4cP9y7AW)5J&{+W68n-lN zWZZ}}QK*cUMOSdcG6*Z9aiuz9#5WuGOnNm0$Z4%FcE=i96`3)1dh3|?M^D2eJ=T7T zC;rFPXNBF?N_`w0tgVaLQPU0+?4m z`dj)dxh23k;?<;W8*g77batd87r%dzT`Fz;v8AZN1B{1;t9yjYoO{RH1rRRF7pUD% z%a{Ni$?N7^BQ%6vpqSDf=i6KR4=#9BQ_8+~Qz%J98$WK>;)|>bMY^o2v_X;BkyeW> z9m`JCdyd=TB6**oODC!_vKA9L;F(RQ2~tE`av@P98L2?*#ZBgzC-A)ICUW%HY<`o! zL@Fj(gpG-LAv!`31j6b69Lw;NXMLA;2LL}&vWW&s=zk0|7dOam*5 zgkO*>&41_$^&rCD*AnmRlp$DK6gQ8zs^#{@@B8tOWA%1}HnR95+U$ObYtzG#cDXC5 ziNA}6?NbU%c7m12hR;$N1O7NoTnxNio?&9sELg?=%9z>hD+Ixhlo-8l$C$FK9n!b&y%VI)x=! z8+Y?;=3$)z*Um2>pIe*$O&s?h5dTRU`T>lpbFBYt*GZi*(Rt{lZk{!|@vHojFa6`( zSCnS$pDpdHufzGVZe4X9IhAqEc(>1m7(*5n0EfTUBwDa;ienzNYv@S$_A`;zdidC) znC1ez&T@IG)&ew4AYHydR;Cj`2~xQW&(o}CvU+T#is zDMt;$q}~SjkdA}fg}`wqPx14m{cG5sUM#W7+~?eGK!1cwZCi{bm#|kTE)=?1{a^>= z4U({NHG!xW^Ng0cN%4#&qgQFeBGS2jABizLHiSUtL>@}j%txmUq+q^X;^OV%+(c|+ zAI6)Qw9i*_?Kcjak3J;MJ#AKl-=v36Imxlw0@Q(6bi|{?8 zq|d}`Vm8{(BHy|IMH7qOC|y0sj@E7hHswD3e#91`V=tiibp~ByB`;pe+nQKE70#9v zNv{@oJWNBELQwHgrh}O=@!yb*S>(-M5D&pyrd*tTo$dmX(V(EwCiJJ5k$R2%Oyp%CV>BDf?Pu zudz(4+f3K&0d>teZ&_S0`L8)pXR*`^_p2?`7OIW z19e^V!zO#vxiY_!9bW`bm|-J&mhq{&)=4i$50n|lU-Rrx1@4HgBLwyq^Eakl>$>qs zxdj@HZ!0F%Ncu{vv3AwMYDOP$r8~{G`#-6ms*9GJa(!Zu^`E z_>Wom%jf1SLb=9JK<0Y)3W8Y~B z35*;cnWy5QkI5K9dF8^TAa1Z;bFqv8*vIxsOfMGC)S3k1^fY|htallqq#|3CaDI%5 z;(Ku``@8gK?CPf90E6Ys0Ycu%9H7OmAbE;#?&w0*b3S&|2p0fHbxWIsR;F-Bx^P?k zvC4Ez?_*Gz#52xp)u8ouS%EkFMudo1auX`O-?8}}m)2>t)41uYh6)?!lIN9sR9BPP>19zZz|O_x!;vkqU?Tl ze_9!XFnFD#h5n+?9J{WA(ZtvEN8?z*qn7{jG3#P228%y=CiEAW%HV?}7_Ya$wQB(msI2LOG#GdbWItLzg)7v0kwCXzhgB)v^5uSl-39ZVJ z!P{)VBqle2{YkTEzCcv+@!oHTx90Dxzw@8r`vZ;e#L;qHQ5+3!82yBK1?1hhB){oX z7&ZYVG+{?yu;h!k?}zUZjK7U3VbYtCyfVjb)qoo#vth6V-1sc!=;Q5ua#tvd*$xR= z^6BIoL}9-_nfu1P!lnendU9y=)`pp}9f#%V*CP%q&UNp7HJU!M^fPaCr2#L@?|zld zPL!+M2KDtklJwYRogyrsm28NL6i^s=VQMZw=3p~F{yN|0k^4vL7wQUYeE}X4-JuIV zKwOl(n?Ooz{fak#D4(5>PctGUO#jTVEYGaE0dY|M=whl=>`>`Td>gVxpn0|xMf|=G zn$L=D7`+&s>foVA_Tx7jwmBDDNZ4y?Z`O~#52-*zH>sW#RICg1Q|@J1p*kyWTh{D> z%SVJ;jPLfb0Cf;@Ft=Rof?k^7g|(Z^f3vPo9H2n_DhE&dnv#~fGOeHJlc%J8KKL=% zRP*n5KOGNlChRe;un-7u(nM^9i+o7^`~QjiNu@z_1^w%* z#<3OxVG48bxd&G4hHRo$o~-9^l3xZOu21!?Hsc*#{7u8apKp-Ki{cBjOfl=nFAAGs z>8ezkD!mvaEV1IZTh`ei2SZo{+$8KY?ZmM-~X7wt4Sr((BFvh#@;%{iEYXh z^PfuAA4NwZ=~iL-exdD}sRl@)C6b4tegR>J6)0PPOnKn)0mfXj>OVy~V*vivJdhM` z^eSjbI+{pBWgq|$mk8F@7KXMCeiP1?8)n?TG7Ag`p~5<0w~ZRpWHvCLgr@hy$}6aEvbJTnfAP|rVa9l z{^k8dA@dq#B2Tk1-{A8qg|^OZ^{@SCC0|?TT~#@IZZRvQM;qA&=v3BnLZ)VL`P!?L zkoJL6A)vAfDC(9DvXRR~K_it$QFqu$g?0n~_<>5CZ@t?j72zY8s8=p1YyDhEYCy`U ze!UgxhR^H@-`R{N(xUg*uC5s>LGs_82%BxH;+f=a*#lTt=$h zq2=#~s{p0enFwcJ<2K<$qeL0a2o&Iam#W^DHLA+^rPzCPgdShY=-*B_e*i~`PD)^X z%M{BOg;K5_d*1?S%f6C6eqUO~GB~aFL zz7s+&0u*Lv;+u=C%KrZCeD0!=A*6FxzoEBX7b=^{w2v8gJRQ&avZ@G~BjVgJ1Tbya zjZzmX{r~yk1DeF0r3TSV)Xzrd^m6`xzY76QW7!m=dLXuJ + + + + + + + + + + + + + + + + + F# Formatting: Documentation Tools for F# Code + | FSharp.Formatting + + + + + + + + + + + + + +
                        +
                        + + + Header menu logo + FSharp.Formatting + +
                        +
                        + + + + + +
                        +
                        + +
                        +
                        +

                        F# Formatting: Documentation Tools for F# Code

                        +

                        FSharp.Formatting is a set of libraries and tools for processing F# script files, markdown and for +generating API documentation. F# Formatting package is used by this project and many other repositories.

                        +

                        To use the tool, install and use the fsdocs tool in a typical F# project with +F# project files plus markdown and script content in the docs directory:

                        +
                        dotnet tool install fsdocs-tool
+dotnet fsdocs build 
+dotnet fsdocs watch
+
                        +

                        To use the tool, explore the following topics:

                        +
                          +

                        • Authoring Content - explains the content expected in the docs directory for the fsdocs tool.

                          • +

                        • Using the Command line tool - explains how to use the fsdocs tool.

                          • +
                        • +

                          Generating API documentation - how to generate HTML documentation +from "XML comments" in your .NET libraries. The tool handles comments written in +Markdown too.

                          +
                          • +

                        • Styling - explains some options for styling the output of fsdocs.

                          • +
                        • +

                          Using literate programming - explains how to generate documentation +for your projects or to write nicely formatted F# blog posts.

                          +
                          • +
                        • +

                          Embedding F# outputs in literate programming - provides more details on literate programming and +explains how to embed results of a literate script file in the generated output. This way, +you can easily format the results of running your code!

                          +
                          • +
                        +

                        Using FSharp.Formatting as a library

                        +

                        F# Formatting is also available on NuGet as a set of libraries.

                        +
                          +
                        • +

                          Markdown parser - explains the F# Markdown +processor that is available in this library with some basic examples of +document processing.

                          +
                          • +
                        • +

                          F# code formatting - more details about the F# code +formatter and how to use it to obtain information about F# source files.

                          +
                          • +
                        +

                        More information

                        +

                        The documentation for this library is generated automatically using the tools +built here. If you spot a typo, please submit a pull request! The source Markdown and F# script files are +available in the docs folder on GitHub.

                        +

                        The project is hosted on GitHub where you can +report issues, fork the project and submit pull requests. +See the License file in the GitHub repository.

                        + + +
                        +
                        + + + +
                        +
                          +

                          Type something to start searching.

                          +
                          +                           + + + + + + + + \ No newline at end of file diff --git a/index.ipynb b/index.ipynb new file mode 100644 index 000000000..7217406fd --- /dev/null +++ b/index.ipynb @@ -0,0 +1,100 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "# F# Formatting: Documentation Tools for F# Code\n", + "\n", + "FSharp.Formatting is a set of libraries and tools for processing F# script files, markdown and for\n", + "generating API documentation. F# Formatting package is used by this project and many other repositories.\n", + "\n", + "To use the tool, install and use the [fsdocs](commandline.html) tool in a typical F# project with\n", + "F# project files plus markdown and script content in the `docs` directory:\n", + "\n", + " dotnet tool install fsdocs-tool\n", + " dotnet fsdocs build \n", + " dotnet fsdocs watch\n", + "\n", + "To use the tool, explore the following topics:\n", + "\n", + "* [Authoring Content](content.html) - explains the content expected in the `docs` directory for the `fsdocs` tool.\n", + " \n", + "\n", + "* [Using the Command line tool](commandline.html) - explains how to use the `fsdocs` tool.\n", + " \n", + "\n", + "* [Generating API documentation](apidocs.html) - how to generate HTML documentation\n", + "from \"XML comments\" in your .NET libraries. The tool handles comments written in\n", + "Markdown too.\n", + " \n", + "\n", + "* [Styling](styling.html) - explains some options for styling the output of `fsdocs`.\n", + " \n", + "\n", + "* [Using literate programming](literate.html) - explains how to generate documentation\n", + "for your projects or to write nicely formatted F# blog posts.\n", + " \n", + "\n", + "* [Embedding F# outputs in literate programming](evaluation.html) - provides more details on literate programming and\n", + "explains how to embed results of a literate script file in the generated output. This way,\n", + "you can easily format the results of running your code!\n", + " \n", + "\n", + "## Using FSharp.Formatting as a library\n", + "\n", + "F# Formatting is also [available on NuGet](https://nuget.org/packages/FSharp.Formatting) as a set of libraries.\n", + "\n", + "* [Markdown parser](markdown.html) - explains the F# Markdown\n", + "processor that is available in this library with some basic examples of\n", + "document processing.\n", + " \n", + "\n", + "* [F# code formatting](codeformat.html) - more details about the F# code\n", + "formatter and how to use it to obtain information about F# source files.\n", + " \n", + "\n", + "## More information\n", + "\n", + "The documentation for this library is generated automatically using the tools\n", + "built here. If you spot a typo, please submit a pull request! The source Markdown and F# script files are\n", + "available in the [docs folder on GitHub](https://github.com/fsprojects/FSharp.Formatting/tree/master/docs).\n", + "\n", + "The project is hosted on [GitHub](https://github.com/fsprojects/FSharp.Formatting) where you can\n", + "[report issues](https://github.com/fsprojects/FSharp.Formatting/issues), fork the project and submit pull requests.\n", + "See the [License file](https://github.com/fsprojects/FSharp.Formatting/blob/master/LICENSE.md) in the GitHub repository.\n", + "\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/index.json b/index.json new file mode 100644 index 000000000..58740cd01 --- /dev/null +++ b/index.json @@ -0,0 +1 @@ +[{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs.html","title":"FSharp.Formatting.ApiDocs","content":"ApiDocAttribute \nApiDocCollection \nApiDocComment \nApiDocEntity \nApiDocEntityInfo \nApiDocFileExtensions \nApiDocHtml \nApiDocInput \nApiDocMember \nApiDocMemberDetails \nApiDocMemberKind \nApiDocModel \nApiDocNamespace \nApiDocType \nApiDocs \nApiDocsSearchIndexEntry \nAttribute \nDocComment \nMember \nMemberKind \nModule \nModuleInfo \nType \nTypeInfo","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat.html","title":"FSharp.Formatting.CSharpFormat","content":"CLikeFormat \nCPlusPlusFormat \nCSharpFormat \nCodeFormat \nFSharpFormat \nHaskellFormat \nHtmlFormat \nJavaScriptFormat \nMshFormat \nPaketFormat \nPhpFormat \nSourceFormat \nSyntaxHighlighter \nTsqlFormat \nTypeScriptFormat \nVisualBasicFormat","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat.html","title":"FSharp.Formatting.CodeFormat","content":"CodeFormatter \nCodeFormat \nErrorKind \nFormattedContent \nFormattedSnippet \nLine \nSnippet \nSourceError \nTokenKind \nTokenSpan \nTokenSpans \nToolTipSpan \nToolTipSpans","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common.html","title":"FSharp.Formatting.Common","content":"Menu \nPageContentList","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate.html","title":"FSharp.Formatting.Literate","content":"MarkdownPatterns \nIndexText \nLiterate \nLiterateCodeOptions \nLiterateCodeVisibility \nLiterateDocument \nLiterateParagraph \nLiterateParagraphOptions \nLiterateSource \nOutputKind","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation.html","title":"FSharp.Formatting.Literate.Evaluation","content":"FsiEmbedKind \nFsiEvaluationFailedInfo \nFsiEvaluationResult \nFsiEvaluator \nFsiEvaluatorConfig \nIFsiEvaluationResult \nIFsiEvaluator","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown.html","title":"FSharp.Formatting.Markdown","content":"Dsl \nHtmlFormatting \nMarkdownPatterns \nMarkdown \nMarkdownColumnAlignment \nMarkdownDocument \nMarkdownEmbedParagraphs \nMarkdownEmbedSpans \nMarkdownListKind \nMarkdownParagraph \nMarkdownParagraphs \nMarkdownParseOptions \nMarkdownSpan \nMarkdownSpans \nMarkdownTableRow \nMarkdownRange \nMarkdownRange","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating.html","title":"FSharp.Formatting.Templating","content":"ParamKeys \nFrontMatterFile \nParamKey \nSubstitutions","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html","title":"ApiDocAttribute","content":"ApiDocAttribute \n Represents a custom attribute attached to source code \nApiDocAttribute.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocAttribute.Format \nFormat \nApiDocAttribute.FormatFullName \nFormatFullName \nApiDocAttribute.FormatFullNameLongForm \nFormatFullNameLongForm \nApiDocAttribute.FormatLongForm \nFormatLongForm \nApiDocAttribute.ObsoleteMessage \nObsoleteMessage \nApiDocAttribute.IsCustomOperationAttribute \nIsCustomOperationAttribute \nApiDocAttribute.CustomOperationName \nCustomOperationName \nApiDocAttribute.NamedConstructorArguments \nNamedConstructorArguments \nApiDocAttribute.FullName \nFullName \nApiDocAttribute.IsRequireQualifiedAccessAttribute \nIsRequireQualifiedAccessAttribute \nApiDocAttribute.Name \nName \nApiDocAttribute.IsObsoleteAttribute \nIsObsoleteAttribute \nApiDocAttribute.ConstructorArguments \nConstructorArguments","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocAttribute.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocAttribute.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#Format","title":"ApiDocAttribute.Format","content":"ApiDocAttribute.Format \nFormat \n Formats the attribute using the Name. Removes the \u0022Attribute\u0022-suffix. E.g Obsolete","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#FormatFullName","title":"ApiDocAttribute.FormatFullName","content":"ApiDocAttribute.FormatFullName \nFormatFullName \n Formats the attribute using the FullName. Removes the \u0022Attribute\u0022-suffix. E.g System.Obsolete","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#FormatFullNameLongForm","title":"ApiDocAttribute.FormatFullNameLongForm","content":"ApiDocAttribute.FormatFullNameLongForm \nFormatFullNameLongForm \n Formats the attribute using the FullName. Keeps the \u0022Attribute\u0022-suffix. E.g System.ObsoleteAttribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#FormatLongForm","title":"ApiDocAttribute.FormatLongForm","content":"ApiDocAttribute.FormatLongForm \nFormatLongForm \n Formats the attribute using the Name. Keeps the \u0022Attribute\u0022-suffix. E.g ObsoleteAttribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#ObsoleteMessage","title":"ApiDocAttribute.ObsoleteMessage","content":"ApiDocAttribute.ObsoleteMessage \nObsoleteMessage \n Returns the obsolete message, when this attribute is the System.ObsoleteAttribute. When its not or no message was specified, an empty string is returned","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#IsCustomOperationAttribute","title":"ApiDocAttribute.IsCustomOperationAttribute","content":"ApiDocAttribute.IsCustomOperationAttribute \nIsCustomOperationAttribute \n Gets a value indicating whether this attribute the CustomOperationAttribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#CustomOperationName","title":"ApiDocAttribute.CustomOperationName","content":"ApiDocAttribute.CustomOperationName \nCustomOperationName \n Returns the custom operation name, when this attribute is the CustomOperationAttribute. When its not an empty string is returned","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#NamedConstructorArguments","title":"ApiDocAttribute.NamedConstructorArguments","content":"ApiDocAttribute.NamedConstructorArguments \nNamedConstructorArguments \n The named arguments for the attribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#FullName","title":"ApiDocAttribute.FullName","content":"ApiDocAttribute.FullName \nFullName \n The qualified name of the attribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#IsRequireQualifiedAccessAttribute","title":"ApiDocAttribute.IsRequireQualifiedAccessAttribute","content":"ApiDocAttribute.IsRequireQualifiedAccessAttribute \nIsRequireQualifiedAccessAttribute \n Gets a value indicating whether this attribute is RequireQualifiedAccessAttribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#Name","title":"ApiDocAttribute.Name","content":"ApiDocAttribute.Name \nName \n The name of the attribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#IsObsoleteAttribute","title":"ApiDocAttribute.IsObsoleteAttribute","content":"ApiDocAttribute.IsObsoleteAttribute \nIsObsoleteAttribute \n Gets a value indicating whether this attribute is System.ObsoleteAttribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocattribute.html#ConstructorArguments","title":"ApiDocAttribute.ConstructorArguments","content":"ApiDocAttribute.ConstructorArguments \nConstructorArguments \n The arguments to the constructor for the attribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccollection.html","title":"ApiDocCollection","content":"ApiDocCollection \n Represents a group of assemblies integrated with its associated documentation \nApiDocCollection.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocCollection.CollectionName \nCollectionName \nApiDocCollection.Assemblies \nAssemblies \nApiDocCollection.Namespaces \nNamespaces","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccollection.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocCollection.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocCollection.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccollection.html#CollectionName","title":"ApiDocCollection.CollectionName","content":"ApiDocCollection.CollectionName \nCollectionName \n Name of the collection","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccollection.html#Assemblies","title":"ApiDocCollection.Assemblies","content":"ApiDocCollection.Assemblies \nAssemblies \n All assemblies in the collection","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccollection.html#Namespaces","title":"ApiDocCollection.Namespaces","content":"ApiDocCollection.Namespaces \nNamespaces \n All namespaces in the collection","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html","title":"ApiDocComment","content":"ApiDocComment \n Represents a documentation comment attached to source code \nApiDocComment.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocComment.Summary \nSummary \nApiDocComment.Xml \nXml \nApiDocComment.Parameters \nParameters \nApiDocComment.Examples \nExamples \nApiDocComment.Returns \nReturns \nApiDocComment.Exceptions \nExceptions \nApiDocComment.Notes \nNotes \nApiDocComment.Remarks \nRemarks \nApiDocComment.RawData \nRawData","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocComment.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocComment.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Summary","title":"ApiDocComment.Summary","content":"ApiDocComment.Summary \nSummary \n The summary for the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Xml","title":"ApiDocComment.Xml","content":"ApiDocComment.Xml \nXml \n The XElement for the XML doc if available","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Parameters","title":"ApiDocComment.Parameters","content":"ApiDocComment.Parameters \nParameters \n The param sections of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Examples","title":"ApiDocComment.Examples","content":"ApiDocComment.Examples \nExamples \n The examples sections of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Returns","title":"ApiDocComment.Returns","content":"ApiDocComment.Returns \nReturns \n The return sections of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Exceptions","title":"ApiDocComment.Exceptions","content":"ApiDocComment.Exceptions \nExceptions \n The notes sections of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Notes","title":"ApiDocComment.Notes","content":"ApiDocComment.Notes \nNotes \n The notes sections of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#Remarks","title":"ApiDocComment.Remarks","content":"ApiDocComment.Remarks \nRemarks \n The remarks html for comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoccomment.html#RawData","title":"ApiDocComment.RawData","content":"ApiDocComment.RawData \nRawData \n The raw data of the comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html","title":"ApiDocEntity","content":"ApiDocEntity \n Represents a type definition integrated with its associated documentation \nApiDocEntity.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocEntity.OutputFile \nOutputFile \nApiDocEntity.Url \nUrl \nApiDocEntity.AbbreviatedType \nAbbreviatedType \nApiDocEntity.SourceLocation \nSourceLocation \nApiDocEntity.IsObsolete \nIsObsolete \nApiDocEntity.Constructors \nConstructors \nApiDocEntity.AllMembers \nAllMembers \nApiDocEntity.NestedEntities \nNestedEntities \nApiDocEntity.Attributes \nAttributes \nApiDocEntity.StaticParameters \nStaticParameters \nApiDocEntity.ObsoleteMessage \nObsoleteMessage \nApiDocEntity.Substitutions \nSubstitutions \nApiDocEntity.StaticMembers \nStaticMembers \nApiDocEntity.AllInterfaces \nAllInterfaces \nApiDocEntity.Name \nName \nApiDocEntity.UnionCases \nUnionCases \nApiDocEntity.Comment \nComment \nApiDocEntity.ActivePatterns \nActivePatterns \nApiDocEntity.CategoryIndex \nCategoryIndex \nApiDocEntity.Category \nCategory \nApiDocEntity.IsTypeDefinition \nIsTypeDefinition \nApiDocEntity.ValuesAndFuncs \nValuesAndFuncs \nApiDocEntity.InstanceMembers \nInstanceMembers \nApiDocEntity.UrlBaseName \nUrlBaseName \nApiDocEntity.BaseType \nBaseType \nApiDocEntity.Assembly \nAssembly \nApiDocEntity.Exclude \nExclude \nApiDocEntity.Symbol \nSymbol \nApiDocEntity.RecordFields \nRecordFields \nApiDocEntity.TypeExtensions \nTypeExtensions \nApiDocEntity.DelegateSignature \nDelegateSignature \nApiDocEntity.RequiresQualifiedAccess \nRequiresQualifiedAccess \nApiDocEntity.GetUrl \nGetUrl","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocEntity.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocEntity.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#OutputFile","title":"ApiDocEntity.OutputFile","content":"ApiDocEntity.OutputFile \nOutputFile \n The name of the file generated for this entity","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Url","title":"ApiDocEntity.Url","content":"ApiDocEntity.Url \nUrl \n The URL of the best link for the entity relative to \u0022reference\u0022 directory (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#AbbreviatedType","title":"ApiDocEntity.AbbreviatedType","content":"ApiDocEntity.AbbreviatedType \nAbbreviatedType \n If this is a type abbreviation, then the abbreviated type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#SourceLocation","title":"ApiDocEntity.SourceLocation","content":"ApiDocEntity.SourceLocation \nSourceLocation \n The URL of the member\u0027s source location, if any","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#IsObsolete","title":"ApiDocEntity.IsObsolete","content":"ApiDocEntity.IsObsolete \nIsObsolete \n Gets a value indicating whether this member is obsolete","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Constructors","title":"ApiDocEntity.Constructors","content":"ApiDocEntity.Constructors \nConstructors \n The constuctorsof the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#AllMembers","title":"ApiDocEntity.AllMembers","content":"ApiDocEntity.AllMembers \nAllMembers \n All members of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#NestedEntities","title":"ApiDocEntity.NestedEntities","content":"ApiDocEntity.NestedEntities \nNestedEntities \n All nested modules and types","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Attributes","title":"ApiDocEntity.Attributes","content":"ApiDocEntity.Attributes \nAttributes \n The declared attributes of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#StaticParameters","title":"ApiDocEntity.StaticParameters","content":"ApiDocEntity.StaticParameters \nStaticParameters \n Static parameters","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#ObsoleteMessage","title":"ApiDocEntity.ObsoleteMessage","content":"ApiDocEntity.ObsoleteMessage \nObsoleteMessage \n Returns the obsolete message, when this member is obsolete. When its not or no message was specified, an empty string is returned","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Substitutions","title":"ApiDocEntity.Substitutions","content":"ApiDocEntity.Substitutions \nSubstitutions \n The substitution parameters active for generating thist content","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#StaticMembers","title":"ApiDocEntity.StaticMembers","content":"ApiDocEntity.StaticMembers \nStaticMembers \n The static members of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#AllInterfaces","title":"ApiDocEntity.AllInterfaces","content":"ApiDocEntity.AllInterfaces \nAllInterfaces \n All interfaces of the type, formatted","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Name","title":"ApiDocEntity.Name","content":"ApiDocEntity.Name \nName \n The name of the entity","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#UnionCases","title":"ApiDocEntity.UnionCases","content":"ApiDocEntity.UnionCases \nUnionCases \n The cases of a union type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Comment","title":"ApiDocEntity.Comment","content":"ApiDocEntity.Comment \nComment \n The attached comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#ActivePatterns","title":"ApiDocEntity.ActivePatterns","content":"ApiDocEntity.ActivePatterns \nActivePatterns \n Active patterns of the module","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#CategoryIndex","title":"ApiDocEntity.CategoryIndex","content":"ApiDocEntity.CategoryIndex \nCategoryIndex \n The category index of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Category","title":"ApiDocEntity.Category","content":"ApiDocEntity.Category \nCategory \n The category of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#IsTypeDefinition","title":"ApiDocEntity.IsTypeDefinition","content":"ApiDocEntity.IsTypeDefinition \nIsTypeDefinition \n Indicates if the entity is a type definition","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#ValuesAndFuncs","title":"ApiDocEntity.ValuesAndFuncs","content":"ApiDocEntity.ValuesAndFuncs \nValuesAndFuncs \n Values and functions of the module","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#InstanceMembers","title":"ApiDocEntity.InstanceMembers","content":"ApiDocEntity.InstanceMembers \nInstanceMembers \n The instance members of the type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#UrlBaseName","title":"ApiDocEntity.UrlBaseName","content":"ApiDocEntity.UrlBaseName \nUrlBaseName \n The URL base name of the primary documentation for the entity (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#BaseType","title":"ApiDocEntity.BaseType","content":"ApiDocEntity.BaseType \nBaseType \n The base type of the type, formatted","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Assembly","title":"ApiDocEntity.Assembly","content":"ApiDocEntity.Assembly \nAssembly \n The name of the type\u0027s assembly","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Exclude","title":"ApiDocEntity.Exclude","content":"ApiDocEntity.Exclude \nExclude \n The exclude flag","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#Symbol","title":"ApiDocEntity.Symbol","content":"ApiDocEntity.Symbol \nSymbol \n The F# compiler symbol for the type definition","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#RecordFields","title":"ApiDocEntity.RecordFields","content":"ApiDocEntity.RecordFields \nRecordFields \n The fields of a record type","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#TypeExtensions","title":"ApiDocEntity.TypeExtensions","content":"ApiDocEntity.TypeExtensions \nTypeExtensions \n Type extensions of the module","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#DelegateSignature","title":"ApiDocEntity.DelegateSignature","content":"ApiDocEntity.DelegateSignature \nDelegateSignature \n If this is a delegate, then e formatted signature","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#RequiresQualifiedAccess","title":"ApiDocEntity.RequiresQualifiedAccess","content":"ApiDocEntity.RequiresQualifiedAccess \nRequiresQualifiedAccess \n Does the module have the RequiresQualifiedAccess attribute","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentity.html#GetUrl","title":"ApiDocEntity.GetUrl","content":"ApiDocEntity.GetUrl \nGetUrl \n Compute the URL of the best link for the entity relative to \u0022reference\u0022 directory (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html","title":"ApiDocEntityInfo","content":"ApiDocEntityInfo \n High-level information about a module definition \nApiDocEntityInfo.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocEntityInfo.Namespace \nNamespace \nApiDocEntityInfo.ParentModule \nParentModule \nApiDocEntityInfo.Collection \nCollection \nApiDocEntityInfo.Entity \nEntity","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocEntityInfo.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocEntityInfo.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html#Namespace","title":"ApiDocEntityInfo.Namespace","content":"ApiDocEntityInfo.Namespace \nNamespace \n The namespace the entity belongs to","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html#ParentModule","title":"ApiDocEntityInfo.ParentModule","content":"ApiDocEntityInfo.ParentModule \nParentModule \n The parent module, if any.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html#Collection","title":"ApiDocEntityInfo.Collection","content":"ApiDocEntityInfo.Collection \nCollection \n The collection of assemblies the entity belongs to","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocentityinfo.html#Entity","title":"ApiDocEntityInfo.Entity","content":"ApiDocEntityInfo.Entity \nEntity \n The actual entity","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocfileextensions.html","title":"ApiDocFileExtensions","content":"ApiDocFileExtensions \n \nApiDocFileExtensions.InFile \nInFile \nApiDocFileExtensions.InUrl \nInUrl","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocfileextensions.html#InFile","title":"ApiDocFileExtensions.InFile","content":"ApiDocFileExtensions.InFile \nInFile \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocfileextensions.html#InUrl","title":"ApiDocFileExtensions.InUrl","content":"ApiDocFileExtensions.InUrl \nInUrl \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidochtml.html","title":"ApiDocHtml","content":"ApiDocHtml \n Represents some HTML formatted by model generation \nApiDocHtml.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocHtml.HtmlText \nHtmlText \nApiDocHtml.Id \nId","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidochtml.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocHtml.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocHtml.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidochtml.html#HtmlText","title":"ApiDocHtml.HtmlText","content":"ApiDocHtml.HtmlText \nHtmlText \n Get the HTML text of the HTML section","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidochtml.html#Id","title":"ApiDocHtml.Id","content":"ApiDocHtml.Id \nId \n Get the Id of the element when rendered to html, if any","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html","title":"ApiDocInput","content":"ApiDocInput \n Represents an input assembly for API doc generation \nApiDocInput.FromFile \nFromFile \nApiDocInput.Path \nPath \nApiDocInput.XmlFile \nXmlFile \nApiDocInput.SourceFolder \nSourceFolder \nApiDocInput.SourceRepo \nSourceRepo \nApiDocInput.Substitutions \nSubstitutions \nApiDocInput.MarkdownComments \nMarkdownComments \nApiDocInput.Warn \nWarn \nApiDocInput.PublicOnly \nPublicOnly","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#FromFile","title":"ApiDocInput.FromFile","content":"ApiDocInput.FromFile \nFromFile \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#Path","title":"ApiDocInput.Path","content":"ApiDocInput.Path \nPath \n The path to the assembly","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#XmlFile","title":"ApiDocInput.XmlFile","content":"ApiDocInput.XmlFile \nXmlFile \n Override the default XML file (normally assumed to live alongside)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#SourceFolder","title":"ApiDocInput.SourceFolder","content":"ApiDocInput.SourceFolder \nSourceFolder \n The compile-time source folder","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#SourceRepo","title":"ApiDocInput.SourceRepo","content":"ApiDocInput.SourceRepo \nSourceRepo \n The URL the the source repo where the source code lives","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#Substitutions","title":"ApiDocInput.Substitutions","content":"ApiDocInput.Substitutions \nSubstitutions \n The substitutionss active for this input. If specified these\n are used instead of the overall substitutions. This allows different parameters (e.g.\n different authors) for each assembly in a collection.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#MarkdownComments","title":"ApiDocInput.MarkdownComments","content":"ApiDocInput.MarkdownComments \nMarkdownComments \n Whether the input uses markdown comments","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#Warn","title":"ApiDocInput.Warn","content":"ApiDocInput.Warn \nWarn \n Whether doc processing should warn on missing comments","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocinput.html#PublicOnly","title":"ApiDocInput.PublicOnly","content":"ApiDocInput.PublicOnly \nPublicOnly \n Whether to generate only public things","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html","title":"ApiDocMember","content":"ApiDocMember \n Represents an method, property, constructor, function or value, record field, union case or static parameter\n integrated with its associated documentation. Includes extension members. \nApiDocMember.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocMember.Url \nUrl \nApiDocMember.SourceLocation \nSourceLocation \nApiDocMember.Kind \nKind \nApiDocMember.FormatCompiledName \nFormatCompiledName \nApiDocMember.IsObsolete \nIsObsolete \nApiDocMember.FormatModifiers \nFormatModifiers \nApiDocMember.Attributes \nAttributes \nApiDocMember.ObsoleteMessage \nObsoleteMessage \nApiDocMember.Parameters \nParameters \nApiDocMember.Name \nName \nApiDocMember.IsRequireQualifiedAccessAttribute \nIsRequireQualifiedAccessAttribute \nApiDocMember.CustomOperationName \nCustomOperationName \nApiDocMember.UsageHtml \nUsageHtml \nApiDocMember.Comment \nComment \nApiDocMember.Category \nCategory \nApiDocMember.CategoryIndex \nCategoryIndex \nApiDocMember.Modifiers \nModifiers \nApiDocMember.TypeArguments \nTypeArguments \nApiDocMember.CompiledName \nCompiledName \nApiDocMember.UrlBaseName \nUrlBaseName \nApiDocMember.ReturnInfo \nReturnInfo \nApiDocMember.FormatTypeArguments \nFormatTypeArguments \nApiDocMember.Exclude \nExclude \nApiDocMember.Symbol \nSymbol \nApiDocMember.ExtendedType \nExtendedType \nApiDocMember.Details \nDetails \nApiDocMember.GetUrl \nGetUrl","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocMember.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocMember.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Url","title":"ApiDocMember.Url","content":"ApiDocMember.Url \nUrl \n The URL of the best link documentation for the item relative to \u0022reference\u0022 directory (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#SourceLocation","title":"ApiDocMember.SourceLocation","content":"ApiDocMember.SourceLocation \nSourceLocation \n The URL of the member\u0027s source location, if any","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Kind","title":"ApiDocMember.Kind","content":"ApiDocMember.Kind \nKind \n The kind of the member","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#FormatCompiledName","title":"ApiDocMember.FormatCompiledName","content":"ApiDocMember.FormatCompiledName \nFormatCompiledName \n Formats the compiled name","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#IsObsolete","title":"ApiDocMember.IsObsolete","content":"ApiDocMember.IsObsolete \nIsObsolete \n Gets a value indicating whether this member is obsolete","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#FormatModifiers","title":"ApiDocMember.FormatModifiers","content":"ApiDocMember.FormatModifiers \nFormatModifiers \n Formats modifiers","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Attributes","title":"ApiDocMember.Attributes","content":"ApiDocMember.Attributes \nAttributes \n The declared attributes of the member","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#ObsoleteMessage","title":"ApiDocMember.ObsoleteMessage","content":"ApiDocMember.ObsoleteMessage \nObsoleteMessage \n Returns the obsolete message, when this member is obsolete. When its not or no message was specified, an empty string is returned","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Parameters","title":"ApiDocMember.Parameters","content":"ApiDocMember.Parameters \nParameters \n The member\u0027s parameters and associated documentation","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Name","title":"ApiDocMember.Name","content":"ApiDocMember.Name \nName \n Name of the member","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#IsRequireQualifiedAccessAttribute","title":"ApiDocMember.IsRequireQualifiedAccessAttribute","content":"ApiDocMember.IsRequireQualifiedAccessAttribute \nIsRequireQualifiedAccessAttribute \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#CustomOperationName","title":"ApiDocMember.CustomOperationName","content":"ApiDocMember.CustomOperationName \nCustomOperationName \n Returns the custom operation name, when this attribute is the CustomOperationAttribute.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#UsageHtml","title":"ApiDocMember.UsageHtml","content":"ApiDocMember.UsageHtml \nUsageHtml \n The usage section in a typical tooltip","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Comment","title":"ApiDocMember.Comment","content":"ApiDocMember.Comment \nComment \n The attached comment","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Category","title":"ApiDocMember.Category","content":"ApiDocMember.Category \nCategory \n The category","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#CategoryIndex","title":"ApiDocMember.CategoryIndex","content":"ApiDocMember.CategoryIndex \nCategoryIndex \n The category index","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Modifiers","title":"ApiDocMember.Modifiers","content":"ApiDocMember.Modifiers \nModifiers \n The member\u0027s modifiers","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#TypeArguments","title":"ApiDocMember.TypeArguments","content":"ApiDocMember.TypeArguments \nTypeArguments \n The member\u0027s type arguments","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#CompiledName","title":"ApiDocMember.CompiledName","content":"ApiDocMember.CompiledName \nCompiledName \n The member\u0027s compiled name, if any","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#UrlBaseName","title":"ApiDocMember.UrlBaseName","content":"ApiDocMember.UrlBaseName \nUrlBaseName \n The URL base name of the best link documentation for the item (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#ReturnInfo","title":"ApiDocMember.ReturnInfo","content":"ApiDocMember.ReturnInfo \nReturnInfo \n The return section in a typical tooltip","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#FormatTypeArguments","title":"ApiDocMember.FormatTypeArguments","content":"ApiDocMember.FormatTypeArguments \nFormatTypeArguments \n Formats type arguments","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Exclude","title":"ApiDocMember.Exclude","content":"ApiDocMember.Exclude \nExclude \n The exclude flag","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Symbol","title":"ApiDocMember.Symbol","content":"ApiDocMember.Symbol \nSymbol \n The symbol this member is related to","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#ExtendedType","title":"ApiDocMember.ExtendedType","content":"ApiDocMember.ExtendedType \nExtendedType \n The type extended by an extension member, if any","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#Details","title":"ApiDocMember.Details","content":"ApiDocMember.Details \nDetails \n The members details","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmember.html#GetUrl","title":"ApiDocMember.GetUrl","content":"ApiDocMember.GetUrl \nGetUrl \n The URL of the best link documentation for the item relative to \u0022reference\u0022 directory (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberdetails.html","title":"ApiDocMemberDetails","content":"ApiDocMemberDetails \n \nApiDocMemberDetails.ApiDocMemberDetails \nApiDocMemberDetails","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberdetails.html#ApiDocMemberDetails","title":"ApiDocMemberDetails.ApiDocMemberDetails","content":"ApiDocMemberDetails.ApiDocMemberDetails \nApiDocMemberDetails \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html","title":"ApiDocMemberKind","content":"ApiDocMemberKind \n Represents the kind of member \nApiDocMemberKind.ValueOrFunction \nValueOrFunction \nApiDocMemberKind.TypeExtension \nTypeExtension \nApiDocMemberKind.ActivePattern \nActivePattern \nApiDocMemberKind.Constructor \nConstructor \nApiDocMemberKind.InstanceMember \nInstanceMember \nApiDocMemberKind.StaticMember \nStaticMember \nApiDocMemberKind.UnionCase \nUnionCase \nApiDocMemberKind.RecordField \nRecordField \nApiDocMemberKind.StaticParameter \nStaticParameter","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#ValueOrFunction","title":"ApiDocMemberKind.ValueOrFunction","content":"ApiDocMemberKind.ValueOrFunction \nValueOrFunction \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#TypeExtension","title":"ApiDocMemberKind.TypeExtension","content":"ApiDocMemberKind.TypeExtension \nTypeExtension \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#ActivePattern","title":"ApiDocMemberKind.ActivePattern","content":"ApiDocMemberKind.ActivePattern \nActivePattern \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#Constructor","title":"ApiDocMemberKind.Constructor","content":"ApiDocMemberKind.Constructor \nConstructor \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#InstanceMember","title":"ApiDocMemberKind.InstanceMember","content":"ApiDocMemberKind.InstanceMember \nInstanceMember \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#StaticMember","title":"ApiDocMemberKind.StaticMember","content":"ApiDocMemberKind.StaticMember \nStaticMember \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#UnionCase","title":"ApiDocMemberKind.UnionCase","content":"ApiDocMemberKind.UnionCase \nUnionCase \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#RecordField","title":"ApiDocMemberKind.RecordField","content":"ApiDocMemberKind.RecordField \nRecordField \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmemberkind.html#StaticParameter","title":"ApiDocMemberKind.StaticParameter","content":"ApiDocMemberKind.StaticParameter \nStaticParameter \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html","title":"ApiDocModel","content":"ApiDocModel \n Represents a set of assemblies integrated with their associated documentation \nApiDocModel.IndexFileUrl \nIndexFileUrl \nApiDocModel.IndexOutputFile \nIndexOutputFile \nApiDocModel.FileExtensions \nFileExtensions \nApiDocModel.Qualify \nQualify \nApiDocModel.Substitutions \nSubstitutions \nApiDocModel.EntityInfos \nEntityInfos \nApiDocModel.Collection \nCollection \nApiDocModel.Root \nRoot","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#IndexFileUrl","title":"ApiDocModel.IndexFileUrl","content":"ApiDocModel.IndexFileUrl \nIndexFileUrl \n URL of the \u0027index.html\u0027 for the reference documentation for the model","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#IndexOutputFile","title":"ApiDocModel.IndexOutputFile","content":"ApiDocModel.IndexOutputFile \nIndexOutputFile \n URL of the \u0027index.html\u0027 for the reference documentation for the model","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#FileExtensions","title":"ApiDocModel.FileExtensions","content":"ApiDocModel.FileExtensions \nFileExtensions \n Specifies file extensions to use in files and URLs","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#Qualify","title":"ApiDocModel.Qualify","content":"ApiDocModel.Qualify \nQualify \n Indicates if each collection is being qualified by its collection name, e.g. \u0027reference/FSharp.Core\u0027","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#Substitutions","title":"ApiDocModel.Substitutions","content":"ApiDocModel.Substitutions \nSubstitutions \n The substitutions. Different substitutions can also be used for each specific input","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#EntityInfos","title":"ApiDocModel.EntityInfos","content":"ApiDocModel.EntityInfos \nEntityInfos \n The full list of all entities","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#Collection","title":"ApiDocModel.Collection","content":"ApiDocModel.Collection \nCollection \n The full list of all entities","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocmodel.html#Root","title":"ApiDocModel.Root","content":"ApiDocModel.Root \nRoot \n The root URL for the entire generation, normally \u0027/\u0027","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html","title":"ApiDocNamespace","content":"ApiDocNamespace \n Represents a namespace integrated with its associated documentation \nApiDocNamespace.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nApiDocNamespace.OutputFile \nOutputFile \nApiDocNamespace.Url \nUrl \nApiDocNamespace.Entities \nEntities \nApiDocNamespace.UrlBaseName \nUrlBaseName \nApiDocNamespace.UrlHash \nUrlHash \nApiDocNamespace.NamespaceDocs \nNamespaceDocs \nApiDocNamespace.Substitutions \nSubstitutions \nApiDocNamespace.Name \nName","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#\u0060\u0060.ctor\u0060\u0060","title":"ApiDocNamespace.\u0060\u0060.ctor\u0060\u0060","content":"ApiDocNamespace.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#OutputFile","title":"ApiDocNamespace.OutputFile","content":"ApiDocNamespace.OutputFile \nOutputFile \n The name of the file generated for this entity","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#Url","title":"ApiDocNamespace.Url","content":"ApiDocNamespace.Url \nUrl \n The URL of the best link documentation for the item (without the http://site.io/reference)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#Entities","title":"ApiDocNamespace.Entities","content":"ApiDocNamespace.Entities \nEntities \n All modules in the namespace","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#UrlBaseName","title":"ApiDocNamespace.UrlBaseName","content":"ApiDocNamespace.UrlBaseName \nUrlBaseName \n The base name for the generated file","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#UrlHash","title":"ApiDocNamespace.UrlHash","content":"ApiDocNamespace.UrlHash \nUrlHash \n The hash label for the URL with the overall namespaces file","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#NamespaceDocs","title":"ApiDocNamespace.NamespaceDocs","content":"ApiDocNamespace.NamespaceDocs \nNamespaceDocs \n The summary text for the namespace","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#Substitutions","title":"ApiDocNamespace.Substitutions","content":"ApiDocNamespace.Substitutions \nSubstitutions \n The substitution substitutions active for generating thist content","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocnamespace.html#Name","title":"ApiDocNamespace.Name","content":"ApiDocNamespace.Name \nName \n The name of the namespace","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidoctype.html","title":"ApiDocType","content":"ApiDocType \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html","title":"ApiDocs","content":"ApiDocs \n\n This type exposes the functionality for producing documentation model from \u0060dll\u0060 files with associated \u0060xml\u0060 files\n generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the \u0060Generate\u0060 method.\n \nApiDocs.GenerateHtml \nGenerateHtml \nApiDocs.GenerateMarkdown \nGenerateMarkdown \nApiDocs.GenerateModel \nGenerateModel \nApiDocs.SearchIndexEntriesForModel \nSearchIndexEntriesForModel","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateHtml","title":"ApiDocs.GenerateHtml","content":"ApiDocs.GenerateHtml \nGenerateHtml \n\n Generates default HTML pages for the assemblies specified by the \u0060inputs\u0060 parameter\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateMarkdown","title":"ApiDocs.GenerateMarkdown","content":"ApiDocs.GenerateMarkdown \nGenerateMarkdown \n\n Generates default Markdown pages for the assemblies specified by the \u0060inputs\u0060 parameter\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#GenerateModel","title":"ApiDocs.GenerateModel","content":"ApiDocs.GenerateModel \nGenerateModel \n\n Generates a documentation model for the assemblies specified by the \u0060inputs\u0060 parameter\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html#SearchIndexEntriesForModel","title":"ApiDocs.SearchIndexEntriesForModel","content":"ApiDocs.SearchIndexEntriesForModel \nSearchIndexEntriesForModel \n\n Generates the search index from the given documentation model\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html","title":"ApiDocsSearchIndexEntry","content":"ApiDocsSearchIndexEntry \n Represents an entry suitable for constructing a Lunr index \nApiDocsSearchIndexEntry.uri \nuri \nApiDocsSearchIndexEntry.title \ntitle \nApiDocsSearchIndexEntry.content \ncontent \nApiDocsSearchIndexEntry.headings \nheadings \nApiDocsSearchIndexEntry.type \ntype","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html#uri","title":"ApiDocsSearchIndexEntry.uri","content":"ApiDocsSearchIndexEntry.uri \nuri \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html#title","title":"ApiDocsSearchIndexEntry.title","content":"ApiDocsSearchIndexEntry.title \ntitle \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html#content","title":"ApiDocsSearchIndexEntry.content","content":"ApiDocsSearchIndexEntry.content \ncontent \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html#headings","title":"ApiDocsSearchIndexEntry.headings","content":"ApiDocsSearchIndexEntry.headings \nheadings \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html#type","title":"ApiDocsSearchIndexEntry.type","content":"ApiDocsSearchIndexEntry.type \ntype \n apiDocs or content","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-attribute.html","title":"Attribute","content":"Attribute \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-doccomment.html","title":"DocComment","content":"DocComment \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-member.html","title":"Member","content":"Member \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-memberkind.html","title":"MemberKind","content":"MemberKind \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-module.html","title":"Module","content":"Module \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-moduleinfo.html","title":"ModuleInfo","content":"ModuleInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-type.html","title":"Type","content":"Type \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-typeinfo.html","title":"TypeInfo","content":"TypeInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-clikeformat.html","title":"CLikeFormat","content":"CLikeFormat \n\n Provides a base class for formatting languages similar to C.\n \nCLikeFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nCLikeFormat.CommentRegEx \nCommentRegEx \nCLikeFormat.StringRegEx \nStringRegEx","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-clikeformat.html#\u0060\u0060.ctor\u0060\u0060","title":"CLikeFormat.\u0060\u0060.ctor\u0060\u0060","content":"CLikeFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-clikeformat.html#CommentRegEx","title":"CLikeFormat.CommentRegEx","content":"CLikeFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line and multi-line \n comments (// and /* */).","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-clikeformat.html#StringRegEx","title":"CLikeFormat.StringRegEx","content":"CLikeFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-cplusplusformat.html","title":"CPlusPlusFormat","content":"CPlusPlusFormat \n Generates color-coded HTML 4.01 from C\u002B\u002B source code. \nCPlusPlusFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nCPlusPlusFormat.Keywords \nKeywords \nCPlusPlusFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-cplusplusformat.html#\u0060\u0060.ctor\u0060\u0060","title":"CPlusPlusFormat.\u0060\u0060.ctor\u0060\u0060","content":"CPlusPlusFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-cplusplusformat.html#Keywords","title":"CPlusPlusFormat.Keywords","content":"CPlusPlusFormat.Keywords \nKeywords \n The list of C\u002B\u002B keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-cplusplusformat.html#Preprocessors","title":"CPlusPlusFormat.Preprocessors","content":"CPlusPlusFormat.Preprocessors \nPreprocessors \n The list of C\u002B\u002B preprocessors.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-csharpformat.html","title":"CSharpFormat","content":"CSharpFormat \n Generates color-coded HTML 4.01 from C# source code. \nCSharpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nCSharpFormat.Keywords \nKeywords \nCSharpFormat.Preprocessors \nPreprocessors \nCSharpFormat.Operators \nOperators","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-csharpformat.html#\u0060\u0060.ctor\u0060\u0060","title":"CSharpFormat.\u0060\u0060.ctor\u0060\u0060","content":"CSharpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-csharpformat.html#Keywords","title":"CSharpFormat.Keywords","content":"CSharpFormat.Keywords \nKeywords \n The list of C# keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-csharpformat.html#Preprocessors","title":"CSharpFormat.Preprocessors","content":"CSharpFormat.Preprocessors \nPreprocessors \n The list of C# preprocessors.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-csharpformat.html#Operators","title":"CSharpFormat.Operators","content":"CSharpFormat.Operators \nOperators \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html","title":"CodeFormat","content":"CodeFormat \n Provides a base class for formatting most programming languages. \nCodeFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nCodeFormat.Keywords \nKeywords \nCodeFormat.Operators \nOperators \nCodeFormat.Preprocessors \nPreprocessors \nCodeFormat.StringRegEx \nStringRegEx \nCodeFormat.CommentRegEx \nCommentRegEx \nCodeFormat.NumberRegEx \nNumberRegEx \nCodeFormat.CaseSensitive \nCaseSensitive","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#\u0060\u0060.ctor\u0060\u0060","title":"CodeFormat.\u0060\u0060.ctor\u0060\u0060","content":"CodeFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n\u003Cpre\u003E\u003C/pre\u003E","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#Keywords","title":"CodeFormat.Keywords","content":"CodeFormat.Keywords \nKeywords \n\n Must be overridden to provide a list of keywords defined in \n each language.\n \n\n Keywords must be separated with spaces.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#Operators","title":"CodeFormat.Operators","content":"CodeFormat.Operators \nOperators \n\n Must be overridden to provide a list of operators defined in \n each language.\n \n\n Operators must be separated with spaces.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#Preprocessors","title":"CodeFormat.Preprocessors","content":"CodeFormat.Preprocessors \nPreprocessors \n\n Can be overridden to provide a list of preprocessors defined in \n each language.\n \n\n Preprocessors must be separated with spaces.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#StringRegEx","title":"CodeFormat.StringRegEx","content":"CodeFormat.StringRegEx \nStringRegEx \n Must be overridden to provide a regular expression string\n to match strings literals.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#CommentRegEx","title":"CodeFormat.CommentRegEx","content":"CodeFormat.CommentRegEx \nCommentRegEx \n Must be overridden to provide a regular expression string\n to match comments.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#NumberRegEx","title":"CodeFormat.NumberRegEx","content":"CodeFormat.NumberRegEx \nNumberRegEx \n Can be overridden to provide a list of tokes to be recognized as numbers.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-codeformat.html#CaseSensitive","title":"CodeFormat.CaseSensitive","content":"CodeFormat.CaseSensitive \nCaseSensitive \n\n Determines if the language is case sensitive.\n \n\n A case-insensitive language formatter must override this \n property to return false.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html","title":"FSharpFormat","content":"FSharpFormat \n Generates color-coded HTML 4.01 from F# source code. \nFSharpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nFSharpFormat.Operators \nOperators \nFSharpFormat.CommentRegEx \nCommentRegEx \nFSharpFormat.Keywords \nKeywords \nFSharpFormat.StringRegEx \nStringRegEx \nFSharpFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#\u0060\u0060.ctor\u0060\u0060","title":"FSharpFormat.\u0060\u0060.ctor\u0060\u0060","content":"FSharpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#Operators","title":"FSharpFormat.Operators","content":"FSharpFormat.Operators \nOperators \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#CommentRegEx","title":"FSharpFormat.CommentRegEx","content":"FSharpFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line and multi-line \n comments (// and (* *)).","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#Keywords","title":"FSharpFormat.Keywords","content":"FSharpFormat.Keywords \nKeywords \n The list of F# keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#StringRegEx","title":"FSharpFormat.StringRegEx","content":"FSharpFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-fsharpformat.html#Preprocessors","title":"FSharpFormat.Preprocessors","content":"FSharpFormat.Preprocessors \nPreprocessors \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html","title":"HaskellFormat","content":"HaskellFormat \n Generates color-coded HTML 4.01 from MSH (code name Monad) source code. \nHaskellFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nHaskellFormat.CommentRegEx \nCommentRegEx \nHaskellFormat.StringRegEx \nStringRegEx \nHaskellFormat.Keywords \nKeywords \nHaskellFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html#\u0060\u0060.ctor\u0060\u0060","title":"HaskellFormat.\u0060\u0060.ctor\u0060\u0060","content":"HaskellFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html#CommentRegEx","title":"HaskellFormat.CommentRegEx","content":"HaskellFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line comments (#).","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html#StringRegEx","title":"HaskellFormat.StringRegEx","content":"HaskellFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html#Keywords","title":"HaskellFormat.Keywords","content":"HaskellFormat.Keywords \nKeywords \n The list of MSH keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-haskellformat.html#Preprocessors","title":"HaskellFormat.Preprocessors","content":"HaskellFormat.Preprocessors \nPreprocessors \n Use preprocessors property to hilight operators.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-htmlformat.html","title":"HtmlFormat","content":"HtmlFormat \n\n Generates color-coded HTML 4.01 from HTML/XML/ASPX source code.\n \n\u003Cp class=\u0027fsdocs-para\u0027\u003E\n This implementation assumes that code inside \u003Cscript\u003E blocks \n is JavaScript, and code inside \u003C% %\u003E blocks is C#.\u003C/p\u003E\u003Cp class=\u0027fsdocs-para\u0027\u003E\n The default tab width is set to 2 characters in this class.\u003C/p\u003E \nHtmlFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-htmlformat.html#\u0060\u0060.ctor\u0060\u0060","title":"HtmlFormat.\u0060\u0060.ctor\u0060\u0060","content":"HtmlFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n\u003Cpre\u003E\u003C/pre\u003E","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-javascriptformat.html","title":"JavaScriptFormat","content":"JavaScriptFormat \n Generates color-coded HTML 4.01 from JavaSctript source code. \nJavaScriptFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nJavaScriptFormat.Keywords \nKeywords \nJavaScriptFormat.Preprocessors \nPreprocessors \nJavaScriptFormat.Operators \nOperators","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-javascriptformat.html#\u0060\u0060.ctor\u0060\u0060","title":"JavaScriptFormat.\u0060\u0060.ctor\u0060\u0060","content":"JavaScriptFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-javascriptformat.html#Keywords","title":"JavaScriptFormat.Keywords","content":"JavaScriptFormat.Keywords \nKeywords \n The list of JavaScript keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-javascriptformat.html#Preprocessors","title":"JavaScriptFormat.Preprocessors","content":"JavaScriptFormat.Preprocessors \nPreprocessors \n Use the pre-processor color to mark directives that start with @.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-javascriptformat.html#Operators","title":"JavaScriptFormat.Operators","content":"JavaScriptFormat.Operators \nOperators \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html","title":"MshFormat","content":"MshFormat \n Generates color-coded HTML 4.01 from MSH (code name Monad) source code. \nMshFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nMshFormat.CommentRegEx \nCommentRegEx \nMshFormat.StringRegEx \nStringRegEx \nMshFormat.Keywords \nKeywords \nMshFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html#\u0060\u0060.ctor\u0060\u0060","title":"MshFormat.\u0060\u0060.ctor\u0060\u0060","content":"MshFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html#CommentRegEx","title":"MshFormat.CommentRegEx","content":"MshFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line comments (#).","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html#StringRegEx","title":"MshFormat.StringRegEx","content":"MshFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html#Keywords","title":"MshFormat.Keywords","content":"MshFormat.Keywords \nKeywords \n The list of MSH keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-mshformat.html#Preprocessors","title":"MshFormat.Preprocessors","content":"MshFormat.Preprocessors \nPreprocessors \n Use preprocessors property to hilight operators.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html","title":"PaketFormat","content":"PaketFormat \n Generates color-coded Paket source code. \nPaketFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nPaketFormat.CommentRegEx \nCommentRegEx \nPaketFormat.Operators \nOperators \nPaketFormat.Keywords \nKeywords \nPaketFormat.NumberRegEx \nNumberRegEx","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html#\u0060\u0060.ctor\u0060\u0060","title":"PaketFormat.\u0060\u0060.ctor\u0060\u0060","content":"PaketFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html#CommentRegEx","title":"PaketFormat.CommentRegEx","content":"PaketFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line and multi-line \n comments (// and (* *)). Single line comments should have to have \n a space after them to avoid color as comments URLs and paths. For example","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html#Operators","title":"PaketFormat.Operators","content":"PaketFormat.Operators \nOperators \n Paket operators","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html#Keywords","title":"PaketFormat.Keywords","content":"PaketFormat.Keywords \nKeywords \n Paket Keywords","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-paketformat.html#NumberRegEx","title":"PaketFormat.NumberRegEx","content":"PaketFormat.NumberRegEx \nNumberRegEx \n Matches version numbers","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-phpformat.html","title":"PhpFormat","content":"PhpFormat \n Generates color-coded HTML 4.01 from PHP source code. \nPhpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nPhpFormat.StringRegEx \nStringRegEx \nPhpFormat.Keywords \nKeywords \nPhpFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-phpformat.html#\u0060\u0060.ctor\u0060\u0060","title":"PhpFormat.\u0060\u0060.ctor\u0060\u0060","content":"PhpFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-phpformat.html#StringRegEx","title":"PhpFormat.StringRegEx","content":"PhpFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-phpformat.html#Keywords","title":"PhpFormat.Keywords","content":"PhpFormat.Keywords \nKeywords \n The list of PHP keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-phpformat.html#Preprocessors","title":"PhpFormat.Preprocessors","content":"PhpFormat.Preprocessors \nPreprocessors \n The list of PHP preprocessors.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html","title":"SourceFormat","content":"SourceFormat \n\n Provides a base implementation for all code formatters.\n \n\u003Cp class=\u0027fsdocs-para\u0027\u003E\n To display the formatted code on your web site, the web page must \n refer to a stylesheet that defines the formatting for the different \n CSS classes generated by CSharpFormat:\n .csharpcode, pre, .rem, .kwrd, .str, .op, .preproc, .alt, .lnum.\n \u003C/p\u003E\u003Cp class=\u0027fsdocs-para\u0027\u003E\n Note that if you have multi-line comments in your source code\n (like /* ... */), the \u0022line numbers\u0022 or \u0022alternate line background\u0022 \n options will generate code that is not strictly HTML 4.01 compliant. \n The code will still look good with IE5\u002B or Mozilla 0.8\u002B. \n \u003C/p\u003E \nSourceFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nSourceFormat.FormatCode \nFormatCode \nSourceFormat.FormatCode \nFormatCode \nSourceFormat.FormatSubCode \nFormatSubCode \nSourceFormat.TabSpaces \nTabSpaces \nSourceFormat.LineNumbers \nLineNumbers \nSourceFormat.Alternate \nAlternate \nSourceFormat.EmbedStyleSheet \nEmbedStyleSheet \nSourceFormat.CodeRegex \nCodeRegex \nSourceFormat.GetCssStream \nGetCssStream \nSourceFormat.GetCssString \nGetCssString \nSourceFormat.EscapeHtml \nEscapeHtml","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#\u0060\u0060.ctor\u0060\u0060","title":"SourceFormat.\u0060\u0060.ctor\u0060\u0060","content":"SourceFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n\u003Cpre\u003E\u003C/pre\u003E","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#FormatCode","title":"SourceFormat.FormatCode","content":"SourceFormat.FormatCode \nFormatCode \n\n Transforms a source code stream to HTML 4.01.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#FormatCode","title":"SourceFormat.FormatCode","content":"SourceFormat.FormatCode \nFormatCode \n\n Transforms a source code string to HTML 4.01.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#FormatSubCode","title":"SourceFormat.FormatSubCode","content":"SourceFormat.FormatSubCode \nFormatSubCode \n Allows formatting a part of the code in a different language,\n for example a JavaScript block inside an HTML file.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#TabSpaces","title":"SourceFormat.TabSpaces","content":"SourceFormat.TabSpaces \nTabSpaces \n\n Gets or sets the tabs width.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#LineNumbers","title":"SourceFormat.LineNumbers","content":"SourceFormat.LineNumbers \nLineNumbers \n\n Enables or disables line numbers in output.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#Alternate","title":"SourceFormat.Alternate","content":"SourceFormat.Alternate \nAlternate \n\n Enables or disables alternating line background.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#EmbedStyleSheet","title":"SourceFormat.EmbedStyleSheet","content":"SourceFormat.EmbedStyleSheet \nEmbedStyleSheet \n\n Enables or disables the embedded CSS style sheet.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#CodeRegex","title":"SourceFormat.CodeRegex","content":"SourceFormat.CodeRegex \nCodeRegex \n The regular expression used to capture language tokens.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#GetCssStream","title":"SourceFormat.GetCssStream","content":"SourceFormat.GetCssStream \nGetCssStream \n\n Gets the CSS stylesheet as a stream.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#GetCssString","title":"SourceFormat.GetCssString","content":"SourceFormat.GetCssString \nGetCssString \n\n Gets the CSS stylesheet as a string.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-sourceformat.html#EscapeHtml","title":"SourceFormat.EscapeHtml","content":"SourceFormat.EscapeHtml \nEscapeHtml \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html","title":"SyntaxHighlighter","content":"SyntaxHighlighter \n Summary description for SyntaxHighlighter \nSyntaxHighlighter.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nSyntaxHighlighter.FormatHtml \nFormatHtml \nSyntaxHighlighter.FormatCode \nFormatCode","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html#\u0060\u0060.ctor\u0060\u0060","title":"SyntaxHighlighter.\u0060\u0060.ctor\u0060\u0060","content":"SyntaxHighlighter.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html#FormatHtml","title":"SyntaxHighlighter.FormatHtml","content":"SyntaxHighlighter.FormatHtml \nFormatHtml \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html#FormatCode","title":"SyntaxHighlighter.FormatCode","content":"SyntaxHighlighter.FormatCode \nFormatCode \n TBD","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html","title":"TsqlFormat","content":"TsqlFormat \n Generates color-coded T-SQL source code. \nTsqlFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nTsqlFormat.CommentRegEx \nCommentRegEx \nTsqlFormat.StringRegEx \nStringRegEx \nTsqlFormat.CaseSensitive \nCaseSensitive \nTsqlFormat.Keywords \nKeywords \nTsqlFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#\u0060\u0060.ctor\u0060\u0060","title":"TsqlFormat.\u0060\u0060.ctor\u0060\u0060","content":"TsqlFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#CommentRegEx","title":"TsqlFormat.CommentRegEx","content":"TsqlFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match single line \n comments (--).","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#StringRegEx","title":"TsqlFormat.StringRegEx","content":"TsqlFormat.StringRegEx \nStringRegEx \n Regular expression string to match string literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#CaseSensitive","title":"TsqlFormat.CaseSensitive","content":"TsqlFormat.CaseSensitive \nCaseSensitive \n\n Returns \u003Cb\u003Efalse\u003C/b\u003E, since T-SQL is not case sensitive.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#Keywords","title":"TsqlFormat.Keywords","content":"TsqlFormat.Keywords \nKeywords \n The list of T-SQL keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-tsqlformat.html#Preprocessors","title":"TsqlFormat.Preprocessors","content":"TsqlFormat.Preprocessors \nPreprocessors \n Use the pre-processor color to mark keywords that start with @@.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-typescriptformat.html","title":"TypeScriptFormat","content":"TypeScriptFormat \n Generates color-coded HTML 4.01 from TypeScript source code. \nTypeScriptFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nTypeScriptFormat.Keywords \nKeywords","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-typescriptformat.html#\u0060\u0060.ctor\u0060\u0060","title":"TypeScriptFormat.\u0060\u0060.ctor\u0060\u0060","content":"TypeScriptFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-typescriptformat.html#Keywords","title":"TypeScriptFormat.Keywords","content":"TypeScriptFormat.Keywords \nKeywords \n The list of TypeScript keywords extends the ones from JavaScript.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html","title":"VisualBasicFormat","content":"VisualBasicFormat \n Generates color-coded HTML 4.01 from Visual Basic source code. \nVisualBasicFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nVisualBasicFormat.CaseSensitive \nCaseSensitive \nVisualBasicFormat.CommentRegEx \nCommentRegEx \nVisualBasicFormat.StringRegEx \nStringRegEx \nVisualBasicFormat.Keywords \nKeywords \nVisualBasicFormat.Preprocessors \nPreprocessors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#\u0060\u0060.ctor\u0060\u0060","title":"VisualBasicFormat.\u0060\u0060.ctor\u0060\u0060","content":"VisualBasicFormat.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#CaseSensitive","title":"VisualBasicFormat.CaseSensitive","content":"VisualBasicFormat.CaseSensitive \nCaseSensitive \n\n Determines if the language is case sensitive.\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#CommentRegEx","title":"VisualBasicFormat.CommentRegEx","content":"VisualBasicFormat.CommentRegEx \nCommentRegEx \n Regular expression string to match comments (\u0027 and REM). ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#StringRegEx","title":"VisualBasicFormat.StringRegEx","content":"VisualBasicFormat.StringRegEx \nStringRegEx \n Regular expression string to match string and character literals. ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#Keywords","title":"VisualBasicFormat.Keywords","content":"VisualBasicFormat.Keywords \nKeywords \n The list of VB keywords.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-csharpformat-visualbasicformat.html#Preprocessors","title":"VisualBasicFormat.Preprocessors","content":"VisualBasicFormat.Preprocessors \nPreprocessors \n The list of VB preprocessors.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html","title":"CodeFormatter","content":"CodeFormatter \n Uses agent to handle formatting requests \nCodeFormatter.processDoubleBackticks \nprocessDoubleBackticks \nCodeFormatter.categoryToTokenKind \ncategoryToTokenKind \nCodeFormatter.processSnippetLine \nprocessSnippetLine \nCodeFormatter.processSnippet \nprocessSnippet \nCodeFormatter.fsChecker \nfsChecker \nCodeFormatter.processSourceCode \nprocessSourceCode \nCodeFormatter.ParseAndCheckSource \nParseAndCheckSource","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#processDoubleBackticks","title":"CodeFormatter.processDoubleBackticks","content":"CodeFormatter.processDoubleBackticks \nprocessDoubleBackticks \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#categoryToTokenKind","title":"CodeFormatter.categoryToTokenKind","content":"CodeFormatter.categoryToTokenKind \ncategoryToTokenKind \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#processSnippetLine","title":"CodeFormatter.processSnippetLine","content":"CodeFormatter.processSnippetLine \nprocessSnippetLine \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#processSnippet","title":"CodeFormatter.processSnippet","content":"CodeFormatter.processSnippet \nprocessSnippet \n Process snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#fsChecker","title":"CodeFormatter.fsChecker","content":"CodeFormatter.fsChecker \nfsChecker \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#processSourceCode","title":"CodeFormatter.processSourceCode","content":"CodeFormatter.processSourceCode \nprocessSourceCode \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformatter.html#ParseAndCheckSource","title":"CodeFormatter.ParseAndCheckSource","content":"CodeFormatter.ParseAndCheckSource \nParseAndCheckSource \n Parse, check and annotate the source code specified by \u0027source\u0027, assuming that it\n is located in a specified \u0027file\u0027. Optional arguments can be used\n to give compiler command line options and preprocessor definitions","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html","title":"CodeFormat","content":"CodeFormat \n Exposes functionality of the F# code formatter with a nice interface \nCodeFormat.FormatFsx \nFormatFsx \nCodeFormat.FormatHtml \nFormatHtml \nCodeFormat.FormatLatex \nFormatLatex","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatFsx","title":"CodeFormat.FormatFsx","content":"CodeFormat.FormatFsx \nFormatFsx \n Formats the .fsx snippets as iPython notebook using the default settings.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatHtml","title":"CodeFormat.FormatHtml","content":"CodeFormat.FormatHtml \nFormatHtml \n Formats the .fsx snippets as HTML. The parameters specify prefix for HTML tags, whether lines should\n be added to outputs and whether errors should be printed.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-codeformat.html#FormatLatex","title":"CodeFormat.FormatLatex","content":"CodeFormat.FormatLatex \nFormatLatex \n Formats the .fsx snippets as LaTeX. The parameters specify prefix for LaTeX tags, whether lines should\n be added to outputs.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-errorkind.html","title":"ErrorKind","content":"ErrorKind \n Represents a kind of error reported from the F# compiler (warning or error) \nErrorKind.Error \nError \nErrorKind.Warning \nWarning","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-errorkind.html#Error","title":"ErrorKind.Error","content":"ErrorKind.Error \nError \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-errorkind.html#Warning","title":"ErrorKind.Warning","content":"ErrorKind.Warning \nWarning \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedcontent.html","title":"FormattedContent","content":"FormattedContent \n Represents formatted snippets \nFormattedContent.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nFormattedContent.Snippets \nSnippets \nFormattedContent.ToolTip \nToolTip","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedcontent.html#\u0060\u0060.ctor\u0060\u0060","title":"FormattedContent.\u0060\u0060.ctor\u0060\u0060","content":"FormattedContent.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedcontent.html#Snippets","title":"FormattedContent.Snippets","content":"FormattedContent.Snippets \nSnippets \n Returns the processed snippets as an array","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedcontent.html#ToolTip","title":"FormattedContent.ToolTip","content":"FormattedContent.ToolTip \nToolTip \n Returns string with ToolTip elements for all the snippets","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedsnippet.html","title":"FormattedSnippet","content":"FormattedSnippet \n\n Represents an individual formatted snippet with title as key\n \nFormattedSnippet.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nFormattedSnippet.Content \nContent \nFormattedSnippet.Key \nKey \nFormattedSnippet.Title \nTitle","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedsnippet.html#\u0060\u0060.ctor\u0060\u0060","title":"FormattedSnippet.\u0060\u0060.ctor\u0060\u0060","content":"FormattedSnippet.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedsnippet.html#Content","title":"FormattedSnippet.Content","content":"FormattedSnippet.Content \nContent \n Returns the formatted content code for the snipet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedsnippet.html#Key","title":"FormattedSnippet.Key","content":"FormattedSnippet.Key \nKey \n Returns the key of the snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-formattedsnippet.html#Title","title":"FormattedSnippet.Title","content":"FormattedSnippet.Title \nTitle \n Returns the title of the snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-line.html","title":"Line","content":"Line \n Represents a line of source code as a list of TokenSpan values. This is\n a single case discriminated union with Line constructor. \nLine.Line \nLine","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-line.html#Line","title":"Line.Line","content":"Line.Line \nLine \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-snippet.html","title":"Snippet","content":"Snippet \n An F# snippet consists of a snippet title and a list of lines \nSnippet.Snippet \nSnippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-snippet.html#Snippet","title":"Snippet.Snippet","content":"Snippet.Snippet \nSnippet \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-sourceerror.html","title":"SourceError","content":"SourceError \n Error reported from the F# compiler consists of location (start and end),\n error kind and the message (wrapped in a single case discriminated union\n with constructor SourceError) \nSourceError.SourceError \nSourceError","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-sourceerror.html#SourceError","title":"SourceError.SourceError","content":"SourceError.SourceError \nSourceError \n Error reported from the F# compiler consists of location (start and end),\n error kind and the message","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html","title":"TokenKind","content":"TokenKind \n Classifies tokens reported by the FCS \nTokenKind.Keyword \nKeyword \nTokenKind.String \nString \nTokenKind.Comment \nComment \nTokenKind.Identifier \nIdentifier \nTokenKind.Inactive \nInactive \nTokenKind.Number \nNumber \nTokenKind.Operator \nOperator \nTokenKind.Punctuation \nPunctuation \nTokenKind.Preprocessor \nPreprocessor \nTokenKind.Module \nModule \nTokenKind.ReferenceType \nReferenceType \nTokenKind.ValueType \nValueType \nTokenKind.Interface \nInterface \nTokenKind.TypeArgument \nTypeArgument \nTokenKind.Property \nProperty \nTokenKind.Enumeration \nEnumeration \nTokenKind.UnionCase \nUnionCase \nTokenKind.Function \nFunction \nTokenKind.Pattern \nPattern \nTokenKind.MutableVar \nMutableVar \nTokenKind.Disposable \nDisposable \nTokenKind.Printf \nPrintf \nTokenKind.Escaped \nEscaped \nTokenKind.Default \nDefault","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Keyword","title":"TokenKind.Keyword","content":"TokenKind.Keyword \nKeyword \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#String","title":"TokenKind.String","content":"TokenKind.String \nString \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Comment","title":"TokenKind.Comment","content":"TokenKind.Comment \nComment \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Identifier","title":"TokenKind.Identifier","content":"TokenKind.Identifier \nIdentifier \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Inactive","title":"TokenKind.Inactive","content":"TokenKind.Inactive \nInactive \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Number","title":"TokenKind.Number","content":"TokenKind.Number \nNumber \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Operator","title":"TokenKind.Operator","content":"TokenKind.Operator \nOperator \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Punctuation","title":"TokenKind.Punctuation","content":"TokenKind.Punctuation \nPunctuation \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Preprocessor","title":"TokenKind.Preprocessor","content":"TokenKind.Preprocessor \nPreprocessor \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Module","title":"TokenKind.Module","content":"TokenKind.Module \nModule \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#ReferenceType","title":"TokenKind.ReferenceType","content":"TokenKind.ReferenceType \nReferenceType \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#ValueType","title":"TokenKind.ValueType","content":"TokenKind.ValueType \nValueType \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Interface","title":"TokenKind.Interface","content":"TokenKind.Interface \nInterface \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#TypeArgument","title":"TokenKind.TypeArgument","content":"TokenKind.TypeArgument \nTypeArgument \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Property","title":"TokenKind.Property","content":"TokenKind.Property \nProperty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Enumeration","title":"TokenKind.Enumeration","content":"TokenKind.Enumeration \nEnumeration \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#UnionCase","title":"TokenKind.UnionCase","content":"TokenKind.UnionCase \nUnionCase \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Function","title":"TokenKind.Function","content":"TokenKind.Function \nFunction \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Pattern","title":"TokenKind.Pattern","content":"TokenKind.Pattern \nPattern \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#MutableVar","title":"TokenKind.MutableVar","content":"TokenKind.MutableVar \nMutableVar \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Disposable","title":"TokenKind.Disposable","content":"TokenKind.Disposable \nDisposable \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Printf","title":"TokenKind.Printf","content":"TokenKind.Printf \nPrintf \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Escaped","title":"TokenKind.Escaped","content":"TokenKind.Escaped \nEscaped \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenkind.html#Default","title":"TokenKind.Default","content":"TokenKind.Default \nDefault \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspan.html","title":"TokenSpan","content":"TokenSpan \n A token in a parsed F# code snippet. Aside from standard tokens reported from\n the compiler (Token), this also includes Error (wrapping the underlined\n tokens), Omitted for the special [omit:...] tags and Output for the special [output:...] tag \nTokenSpan.Token \nToken \nTokenSpan.Error \nError \nTokenSpan.Omitted \nOmitted \nTokenSpan.Output \nOutput","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspan.html#Token","title":"TokenSpan.Token","content":"TokenSpan.Token \nToken \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspan.html#Error","title":"TokenSpan.Error","content":"TokenSpan.Error \nError \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspan.html#Omitted","title":"TokenSpan.Omitted","content":"TokenSpan.Omitted \nOmitted \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspan.html#Output","title":"TokenSpan.Output","content":"TokenSpan.Output \nOutput \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html","title":"TokenSpans","content":"TokenSpans \n A type alias representing a list of TokenSpan values \nTokenSpans.Item \nItem \nTokenSpans.IsEmpty \nIsEmpty \nTokenSpans.Tail \nTail \nTokenSpans.Length \nLength \nTokenSpans.Head \nHead \nTokenSpans.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#Item","title":"TokenSpans.Item","content":"TokenSpans.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#IsEmpty","title":"TokenSpans.IsEmpty","content":"TokenSpans.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#Tail","title":"TokenSpans.Tail","content":"TokenSpans.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#Length","title":"TokenSpans.Length","content":"TokenSpans.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#Head","title":"TokenSpans.Head","content":"TokenSpans.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tokenspans.html#Empty","title":"TokenSpans.Empty","content":"TokenSpans.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspan.html","title":"ToolTipSpan","content":"ToolTipSpan \n A tool tip span can be emphasized text, plain text Literal or a line brak \nToolTipSpan.Emphasis \nEmphasis \nToolTipSpan.Literal \nLiteral \nToolTipSpan.HardLineBreak \nHardLineBreak","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspan.html#Emphasis","title":"ToolTipSpan.Emphasis","content":"ToolTipSpan.Emphasis \nEmphasis \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspan.html#Literal","title":"ToolTipSpan.Literal","content":"ToolTipSpan.Literal \nLiteral \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspan.html#HardLineBreak","title":"ToolTipSpan.HardLineBreak","content":"ToolTipSpan.HardLineBreak \nHardLineBreak \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html","title":"ToolTipSpans","content":"ToolTipSpans \n A tool tip consists of a list of items reported from the compiler \nToolTipSpans.Item \nItem \nToolTipSpans.IsEmpty \nIsEmpty \nToolTipSpans.Tail \nTail \nToolTipSpans.Length \nLength \nToolTipSpans.Head \nHead \nToolTipSpans.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#Item","title":"ToolTipSpans.Item","content":"ToolTipSpans.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#IsEmpty","title":"ToolTipSpans.IsEmpty","content":"ToolTipSpans.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#Tail","title":"ToolTipSpans.Tail","content":"ToolTipSpans.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#Length","title":"ToolTipSpans.Length","content":"ToolTipSpans.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#Head","title":"ToolTipSpans.Head","content":"ToolTipSpans.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-codeformat-tooltipspans.html#Empty","title":"ToolTipSpans.Empty","content":"ToolTipSpans.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu.html","title":"Menu","content":"Menu \n \nMenu.MenuItem \nMenuItem \nMenu.createMenu \ncreateMenu \nMenu.isTemplatingAvailable \nisTemplatingAvailable \nMenu.getLastWriteTimes \ngetLastWriteTimes","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu.html#createMenu","title":"Menu.createMenu","content":"Menu.createMenu \ncreateMenu \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu.html#isTemplatingAvailable","title":"Menu.isTemplatingAvailable","content":"Menu.isTemplatingAvailable \nisTemplatingAvailable \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu.html#getLastWriteTimes","title":"Menu.getLastWriteTimes","content":"Menu.getLastWriteTimes \ngetLastWriteTimes \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu-menuitem.html","title":"MenuItem","content":"MenuItem \n \nMenuItem.Link \nLink \nMenuItem.Content \nContent \nMenuItem.IsActive \nIsActive","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu-menuitem.html#Link","title":"MenuItem.Link","content":"MenuItem.Link \nLink \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu-menuitem.html#Content","title":"MenuItem.Content","content":"MenuItem.Content \nContent \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-menu-menuitem.html#IsActive","title":"MenuItem.IsActive","content":"MenuItem.IsActive \nIsActive \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-pagecontentlist.html","title":"PageContentList","content":"PageContentList \n \nPageContentList.EmptyContent \nEmptyContent \nPageContentList.mkPageContentMenu \nmkPageContentMenu","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-pagecontentlist.html#EmptyContent","title":"PageContentList.EmptyContent","content":"PageContentList.EmptyContent \nEmptyContent \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-common-pagecontentlist.html#mkPageContentMenu","title":"PageContentList.mkPageContentMenu","content":"PageContentList.mkPageContentMenu \nmkPageContentMenu \n We process the html to collect the table of content.\n We can\u0027t use the doc.MarkdownDocument because we cannot easily get the generated id values.\n It is safer to parse the html.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-markdownpatterns.html","title":"MarkdownPatterns","content":"MarkdownPatterns \n\n Provides active patterns for extracting \u003Ccode\u003ELiterateParagraph\u003C/code\u003E values from\n Markdown documents.\n \nMarkdownPatterns.(|LiterateParagraph|_|) \n(|LiterateParagraph|_|)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-markdownpatterns.html#(|LiterateParagraph|_|)","title":"MarkdownPatterns.(|LiterateParagraph|_|)","content":"MarkdownPatterns.(|LiterateParagraph|_|) \n(|LiterateParagraph|_|) \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-indextext.html","title":"IndexText","content":"IndexText \n \nIndexText.IndexText \nIndexText","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-indextext.html#IndexText","title":"IndexText.IndexText","content":"IndexText.IndexText \nIndexText \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html","title":"Literate","content":"Literate \n\n This type provides three simple methods for calling the literate programming tool.\n The \u003Ccode\u003EConvertMarkdownFile\u003C/code\u003E and \u003Ccode\u003EConvertScriptFile\u003C/code\u003E methods process a single Markdown document\n and F# script, respectively. The \u003Ccode\u003EConvertDirectory\u003C/code\u003E method handles an entire directory tree\n (looking for \u003Ccode\u003E*.fsx\u003C/code\u003E and \u003Ccode\u003E*.md\u003C/code\u003E files).\n \nLiterate.ConvertMarkdownFile \nConvertMarkdownFile \nLiterate.ConvertScriptFile \nConvertScriptFile \nLiterate.ParseAndCheckScriptFile \nParseAndCheckScriptFile \nLiterate.ParseMarkdownFile \nParseMarkdownFile \nLiterate.ParseMarkdownString \nParseMarkdownString \nLiterate.ParsePynbString \nParsePynbString \nLiterate.ParseScriptString \nParseScriptString \nLiterate.ToFsx \nToFsx \nLiterate.ToHtml \nToHtml \nLiterate.ToLatex \nToLatex \nLiterate.ToPynb \nToPynb \nLiterate.WriteHtml \nWriteHtml \nLiterate.WriteLatex \nWriteLatex","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertMarkdownFile","title":"Literate.ConvertMarkdownFile","content":"Literate.ConvertMarkdownFile \nConvertMarkdownFile \n Convert a markdown file into HTML or another output kind","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertScriptFile","title":"Literate.ConvertScriptFile","content":"Literate.ConvertScriptFile \nConvertScriptFile \nConvert a script file into HTML or another output kind","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ParseAndCheckScriptFile","title":"Literate.ParseAndCheckScriptFile","content":"Literate.ParseAndCheckScriptFile \nParseAndCheckScriptFile \n Parse F# Script file to LiterateDocument","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ParseMarkdownFile","title":"Literate.ParseMarkdownFile","content":"Literate.ParseMarkdownFile \nParseMarkdownFile \n\n Parse Markdown document to LiterateDocument\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ParseMarkdownString","title":"Literate.ParseMarkdownString","content":"Literate.ParseMarkdownString \nParseMarkdownString \n\n Parse string as a markdown document\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ParsePynbString","title":"Literate.ParsePynbString","content":"Literate.ParsePynbString \nParsePynbString \n\n Parse pynb string as literate document\n ","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ParseScriptString","title":"Literate.ParseScriptString","content":"Literate.ParseScriptString \nParseScriptString \n Parse string as F# Script to LiterateDocument","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ToFsx","title":"Literate.ToFsx","content":"Literate.ToFsx \nToFsx \n Formate the literate document as an .fsx script","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ToHtml","title":"Literate.ToHtml","content":"Literate.ToHtml \nToHtml \n Format the literate document as HTML without using a template","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ToLatex","title":"Literate.ToLatex","content":"Literate.ToLatex \nToLatex \n Format the literate document as Latex without using a template","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ToPynb","title":"Literate.ToPynb","content":"Literate.ToPynb \nToPynb \n Formate the literate document as an iPython notebook","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#WriteHtml","title":"Literate.WriteHtml","content":"Literate.WriteHtml \nWriteHtml \n Write the literate document as HTML without using a template","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#WriteLatex","title":"Literate.WriteLatex","content":"Literate.WriteLatex \nWriteLatex \n Write the literate document as Latex without using a template","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodeoptions.html","title":"LiterateCodeOptions","content":"LiterateCodeOptions \n\n Additional properties of a literate code snippet, embedded in a\n \u003Ccode\u003ELiterateParagraph.LiterateCode\u003C/code\u003E. The properties specify how should\n a snippet be evaluated and formatted.\n \nLiterateCodeOptions.Evaluate \nEvaluate \nLiterateCodeOptions.OutputName \nOutputName \nLiterateCodeOptions.ExecutionCount \nExecutionCount \nLiterateCodeOptions.Visibility \nVisibility","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodeoptions.html#Evaluate","title":"LiterateCodeOptions.Evaluate","content":"LiterateCodeOptions.Evaluate \nEvaluate \n\n Specifies whether the snippet is evalauted while processing\n Use (*** do-not-eval ***) command to set this to \u003Ccode\u003Efalse\u003C/code\u003E","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodeoptions.html#OutputName","title":"LiterateCodeOptions.OutputName","content":"LiterateCodeOptions.OutputName \nOutputName \n Specifies the name of the output produced by this snippet\n Use the (*** define-output:foo ***) command to set this value\n Other outputs are named cell1, cell2 etc.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodeoptions.html#ExecutionCount","title":"LiterateCodeOptions.ExecutionCount","content":"LiterateCodeOptions.ExecutionCount \nExecutionCount \n Indiciates the execution sequence number of the cell if it has been evaluated","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodeoptions.html#Visibility","title":"LiterateCodeOptions.Visibility","content":"LiterateCodeOptions.Visibility \nVisibility \n Specifies the visibility of the snippet in the generated HTML","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodevisibility.html","title":"LiterateCodeVisibility","content":"LiterateCodeVisibility \n Specifies visibility of a code snippet. \nLiterateCodeVisibility.VisibleCode \nVisibleCode \nLiterateCodeVisibility.HiddenCode \nHiddenCode \nLiterateCodeVisibility.NamedCode \nNamedCode","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodevisibility.html#VisibleCode","title":"LiterateCodeVisibility.VisibleCode","content":"LiterateCodeVisibility.VisibleCode \nVisibleCode \n Ordinary visible code","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodevisibility.html#HiddenCode","title":"LiterateCodeVisibility.HiddenCode","content":"LiterateCodeVisibility.HiddenCode \nHiddenCode \n Hidden snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatecodevisibility.html#NamedCode","title":"LiterateCodeVisibility.NamedCode","content":"LiterateCodeVisibility.NamedCode \nNamedCode \n Named snippet with captured output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html","title":"LiterateDocument","content":"LiterateDocument \n Representation of a literate document - the representation of Paragraphs\n uses an F# discriminated union type and so is best used from F#. \nLiterateDocument.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nLiterateDocument.With \nWith \nLiterateDocument.RootInputFolder \nRootInputFolder \nLiterateDocument.FormattedTips \nFormattedTips \nLiterateDocument.SourceFile \nSourceFile \nLiterateDocument.Paragraphs \nParagraphs \nLiterateDocument.DefinedLinks \nDefinedLinks \nLiterateDocument.MarkdownDocument \nMarkdownDocument \nLiterateDocument.Source \nSource \nLiterateDocument.Diagnostics \nDiagnostics","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#\u0060\u0060.ctor\u0060\u0060","title":"LiterateDocument.\u0060\u0060.ctor\u0060\u0060","content":"LiterateDocument.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#With","title":"LiterateDocument.With","content":"LiterateDocument.With \nWith \n Clone the document and change some of its properties","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#RootInputFolder","title":"LiterateDocument.RootInputFolder","content":"LiterateDocument.RootInputFolder \nRootInputFolder \n Root for computing relative paths","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#FormattedTips","title":"LiterateDocument.FormattedTips","content":"LiterateDocument.FormattedTips \nFormattedTips \n Formatted tool tips","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#SourceFile","title":"LiterateDocument.SourceFile","content":"LiterateDocument.SourceFile \nSourceFile \n Location where the file was loaded from","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#Paragraphs","title":"LiterateDocument.Paragraphs","content":"LiterateDocument.Paragraphs \nParagraphs \n Returns a list of paragraphs in the document","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#DefinedLinks","title":"LiterateDocument.DefinedLinks","content":"LiterateDocument.DefinedLinks \nDefinedLinks \n Returns a dictionary containing explicitly defined links","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#MarkdownDocument","title":"LiterateDocument.MarkdownDocument","content":"LiterateDocument.MarkdownDocument \nMarkdownDocument \n Return as markdown document, throwing away additional stuff","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#Source","title":"LiterateDocument.Source","content":"LiterateDocument.Source \nSource \n Original document source code","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatedocument.html#Diagnostics","title":"LiterateDocument.Diagnostics","content":"LiterateDocument.Diagnostics \nDiagnostics \n Errors","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html","title":"LiterateParagraph","content":"LiterateParagraph \n\n Extends \u003Ccode\u003EMarkdownParagrap\u003C/code\u003E using the \u003Ccode\u003EMarkdownEmbedParagraphs\u003C/code\u003E case with\n additional kinds of paragraphs that can appear in literate F# scripts\n (such as various special commands to embed output of a snippet etc.)\n \nLiterateParagraph.ParagraphOptions \nParagraphOptions \nLiterateParagraph.CodeReference \nCodeReference \nLiterateParagraph.FsiOutputReference \nFsiOutputReference \nLiterateParagraph.FsiMergedOutputReference \nFsiMergedOutputReference \nLiterateParagraph.OutputReference \nOutputReference \nLiterateParagraph.ItValueReference \nItValueReference \nLiterateParagraph.ItRawReference \nItRawReference \nLiterateParagraph.ValueReference \nValueReference \nLiterateParagraph.LiterateCode \nLiterateCode \nLiterateParagraph.LanguageTaggedCode \nLanguageTaggedCode \nLiterateParagraph.RawBlock \nRawBlock","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#ParagraphOptions","title":"LiterateParagraph.ParagraphOptions","content":"LiterateParagraph.ParagraphOptions \nParagraphOptions \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#CodeReference","title":"LiterateParagraph.CodeReference","content":"LiterateParagraph.CodeReference \nCodeReference \n (*** include:foo ***) - Include formatted snippet from other part of the document here","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#FsiOutputReference","title":"LiterateParagraph.FsiOutputReference","content":"LiterateParagraph.FsiOutputReference \nFsiOutputReference \n (*** include-fsi-output ***) - Include output from previous snippet\n (*** include-fsi-output:foo ***) - Include output from a named snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#FsiMergedOutputReference","title":"LiterateParagraph.FsiMergedOutputReference","content":"LiterateParagraph.FsiMergedOutputReference \nFsiMergedOutputReference \n (*** include-fsi-merged-output ***) - Include output from previous snippet\n (*** include-fsi-merged-output:foo ***) - Include output from a named snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#OutputReference","title":"LiterateParagraph.OutputReference","content":"LiterateParagraph.OutputReference \nOutputReference \n (*** include-fsi-output ***) - Include F# Interactive output from previous snippet\n (*** include-fsi-output:foo ***) - Include F# Interactive from a named snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#ItValueReference","title":"LiterateParagraph.ItValueReference","content":"LiterateParagraph.ItValueReference \nItValueReference \n (*** include-it ***) - Include \u0022it\u0022 value from the subsequent snippet here\n (*** include-it:foo ***) - Include \u0022it\u0022 value from a named snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#ItRawReference","title":"LiterateParagraph.ItRawReference","content":"LiterateParagraph.ItRawReference \nItRawReference \n (*** include-it-raw ***) - Include \u0022it\u0022 value from the subsequent snippet here as raw text (Not formatted as fsi)\n (*** include-it-raw:foo ***) - Include \u0022it\u0022 value from a named snippet as raw text (Not formatted as fsi)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#ValueReference","title":"LiterateParagraph.ValueReference","content":"LiterateParagraph.ValueReference \nValueReference \n (*** include-value:foo ***) - Include the formatting of a specified value here","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#LiterateCode","title":"LiterateParagraph.LiterateCode","content":"LiterateParagraph.LiterateCode \nLiterateCode \n Embedded literate code snippet. Consists of source lines and options","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#LanguageTaggedCode","title":"LiterateParagraph.LanguageTaggedCode","content":"LiterateParagraph.LanguageTaggedCode \nLanguageTaggedCode \n Ordinary formatted code snippet in non-F# language (tagged with language code)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraph.html#RawBlock","title":"LiterateParagraph.RawBlock","content":"LiterateParagraph.RawBlock \nRawBlock \n Block simply emitted without any formatting equivalent to \u003Cpre\u003E tag in html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraphoptions.html","title":"LiterateParagraphOptions","content":"LiterateParagraphOptions \n Specifies the options for a literate paragraph \nLiterateParagraphOptions.Condition \nCondition","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literateparagraphoptions.html#Condition","title":"LiterateParagraphOptions.Condition","content":"LiterateParagraphOptions.Condition \nCondition \n Specifies a conditional for inclusion of the snippet paragraph","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatesource.html","title":"LiterateSource","content":"LiterateSource \n Represents the source of a literate document. \nLiterateSource.Markdown \nMarkdown \nLiterateSource.Script \nScript","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatesource.html#Markdown","title":"LiterateSource.Markdown","content":"LiterateSource.Markdown \nMarkdown \n A markdown source","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literatesource.html#Script","title":"LiterateSource.Script","content":"LiterateSource.Script \nScript \n A parsed F# script file consisting of snippets.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html","title":"OutputKind","content":"OutputKind \n Defines the possible output types from literate script (HTML, Latex, Pynb) \nOutputKind.Extension \nExtension \nOutputKind.Html \nHtml \nOutputKind.Latex \nLatex \nOutputKind.Pynb \nPynb \nOutputKind.Fsx \nFsx \nOutputKind.Markdown \nMarkdown","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Extension","title":"OutputKind.Extension","content":"OutputKind.Extension \nExtension \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Html","title":"OutputKind.Html","content":"OutputKind.Html \nHtml \n Requests HTML output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Latex","title":"OutputKind.Latex","content":"OutputKind.Latex \nLatex \n Requests LaTeX output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Pynb","title":"OutputKind.Pynb","content":"OutputKind.Pynb \nPynb \n Requests Notebook output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Fsx","title":"OutputKind.Fsx","content":"OutputKind.Fsx \nFsx \n Requests F# Script output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-outputkind.html#Markdown","title":"OutputKind.Markdown","content":"OutputKind.Markdown \nMarkdown \n Requests Markdown output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html","title":"FsiEmbedKind","content":"FsiEmbedKind \n\n Represents a kind of thing that can be embedded\n \nFsiEmbedKind.FsiOutput \nFsiOutput \nFsiEmbedKind.FsiMergedOutput \nFsiMergedOutput \nFsiEmbedKind.ConsoleOutput \nConsoleOutput \nFsiEmbedKind.ItValue \nItValue \nFsiEmbedKind.ItRaw \nItRaw \nFsiEmbedKind.Value \nValue","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#FsiOutput","title":"FsiEmbedKind.FsiOutput","content":"FsiEmbedKind.FsiOutput \nFsiOutput \n The FSI output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#FsiMergedOutput","title":"FsiEmbedKind.FsiMergedOutput","content":"FsiEmbedKind.FsiMergedOutput \nFsiMergedOutput \n The combined FSI output and console output","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#ConsoleOutput","title":"FsiEmbedKind.ConsoleOutput","content":"FsiEmbedKind.ConsoleOutput \nConsoleOutput \n The stdout from this part of the execution (not including FSI output)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#ItValue","title":"FsiEmbedKind.ItValue","content":"FsiEmbedKind.ItValue \nItValue \n The \u0027it\u0027 value","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#ItRaw","title":"FsiEmbedKind.ItRaw","content":"FsiEmbedKind.ItRaw \nItRaw \n The \u0027it\u0027 value as raw text","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html#Value","title":"FsiEmbedKind.Value","content":"FsiEmbedKind.Value \nValue \n A specific value","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html","title":"FsiEvaluationFailedInfo","content":"FsiEvaluationFailedInfo \n Record that is reported by the EvaluationFailed event when something\n goes wrong during evalutaiton of an expression \nFsiEvaluationFailedInfo.Text \nText \nFsiEvaluationFailedInfo.AsExpression \nAsExpression \nFsiEvaluationFailedInfo.File \nFile \nFsiEvaluationFailedInfo.Exception \nException \nFsiEvaluationFailedInfo.StdErr \nStdErr","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html#Text","title":"FsiEvaluationFailedInfo.Text","content":"FsiEvaluationFailedInfo.Text \nText \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html#AsExpression","title":"FsiEvaluationFailedInfo.AsExpression","content":"FsiEvaluationFailedInfo.AsExpression \nAsExpression \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html#File","title":"FsiEvaluationFailedInfo.File","content":"FsiEvaluationFailedInfo.File \nFile \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html#Exception","title":"FsiEvaluationFailedInfo.Exception","content":"FsiEvaluationFailedInfo.Exception \nException \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html#StdErr","title":"FsiEvaluationFailedInfo.StdErr","content":"FsiEvaluationFailedInfo.StdErr \nStdErr \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html","title":"FsiEvaluationResult","content":"FsiEvaluationResult \n Represents the result of evaluating an F# snippet. This contains\n the generated console output together with a result and its static type. \nFsiEvaluationResult.Output \nOutput \nFsiEvaluationResult.FsiOutput \nFsiOutput \nFsiEvaluationResult.FsiMergedOutput \nFsiMergedOutput \nFsiEvaluationResult.ItValue \nItValue \nFsiEvaluationResult.Result \nResult","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html#Output","title":"FsiEvaluationResult.Output","content":"FsiEvaluationResult.Output \nOutput \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html#FsiOutput","title":"FsiEvaluationResult.FsiOutput","content":"FsiEvaluationResult.FsiOutput \nFsiOutput \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html#FsiMergedOutput","title":"FsiEvaluationResult.FsiMergedOutput","content":"FsiEvaluationResult.FsiMergedOutput \nFsiMergedOutput \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html#ItValue","title":"FsiEvaluationResult.ItValue","content":"FsiEvaluationResult.ItValue \nItValue \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html#Result","title":"FsiEvaluationResult.Result","content":"FsiEvaluationResult.Result \nResult \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html","title":"FsiEvaluator","content":"FsiEvaluator \n A wrapper for F# interactive service that is used to evaluate inline snippets \nFsiEvaluator.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nFsiEvaluator.RegisterTransformation \nRegisterTransformation \nFsiEvaluator.EvaluationFailed \nEvaluationFailed","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#\u0060\u0060.ctor\u0060\u0060","title":"FsiEvaluator.\u0060\u0060.ctor\u0060\u0060","content":"FsiEvaluator.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#RegisterTransformation","title":"FsiEvaluator.RegisterTransformation","content":"FsiEvaluator.RegisterTransformation \nRegisterTransformation \n Register a function that formats (some) values that are produced by the evaluator.\n The specified function should return \u0027Some\u0027 when it knows how to format a value\n and it should return formatted","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluator.html#EvaluationFailed","title":"FsiEvaluator.EvaluationFailed","content":"FsiEvaluator.EvaluationFailed \nEvaluationFailed \n This event is fired whenever an evaluation of an expression fails","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html","title":"FsiEvaluatorConfig","content":"FsiEvaluatorConfig \n Provides configuration options for the FsiEvaluator \nFsiEvaluatorConfig.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nFsiEvaluatorConfig.CreateNoOpFsiObject \nCreateNoOpFsiObject","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html#\u0060\u0060.ctor\u0060\u0060","title":"FsiEvaluatorConfig.\u0060\u0060.ctor\u0060\u0060","content":"FsiEvaluatorConfig.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html#CreateNoOpFsiObject","title":"FsiEvaluatorConfig.CreateNoOpFsiObject","content":"FsiEvaluatorConfig.CreateNoOpFsiObject \nCreateNoOpFsiObject \n Creates a dummy fsi object that does not affect the behaviour of F# Interactive\n (and simply ignores all operations that are done on it). You can use this to\n e.g. disable registered printers that would open new windows etc.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-ifsievaluationresult.html","title":"IFsiEvaluationResult","content":"IFsiEvaluationResult \n An interface that represents FSI evaluation result\n (we make this abstract so that evaluators can store other info)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html","title":"IFsiEvaluator","content":"IFsiEvaluator \n Represents an evaluator for F# snippets embedded in code \nIFsiEvaluator.Evaluate \nEvaluate \nIFsiEvaluator.Format \nFormat","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html#Evaluate","title":"IFsiEvaluator.Evaluate","content":"IFsiEvaluator.Evaluate \nEvaluate \n Called to evaluate a snippet","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html#Format","title":"IFsiEvaluator.Format","content":"IFsiEvaluator.Format \nFormat \n Called to format some part of evaluation result generated by FSI","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html","title":"Dsl","content":"Dsl \n \nDsl.\u0060\u0060#\u0060\u0060 \n\u0060\u0060#\u0060\u0060 \nDsl.\u0060\u0060##\u0060\u0060 \n\u0060\u0060##\u0060\u0060 \nDsl.\u0060\u0060###\u0060\u0060 \n\u0060\u0060###\u0060\u0060 \nDsl.\u0060\u0060####\u0060\u0060 \n\u0060\u0060####\u0060\u0060 \nDsl.\u0060\u0060#####\u0060\u0060 \n\u0060\u0060#####\u0060\u0060 \nDsl.strong \nstrong \nDsl.p \np \nDsl.span \nspan \nDsl.(!!) \n(!!) \nDsl.link \nlink \nDsl.ul \nul \nDsl.ol \nol \nDsl.table \ntable \nDsl.img \nimg","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#\u0060\u0060#\u0060\u0060","title":"Dsl.\u0060\u0060#\u0060\u0060","content":"Dsl.\u0060\u0060#\u0060\u0060 \n\u0060\u0060#\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#\u0060\u0060##\u0060\u0060","title":"Dsl.\u0060\u0060##\u0060\u0060","content":"Dsl.\u0060\u0060##\u0060\u0060 \n\u0060\u0060##\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#\u0060\u0060###\u0060\u0060","title":"Dsl.\u0060\u0060###\u0060\u0060","content":"Dsl.\u0060\u0060###\u0060\u0060 \n\u0060\u0060###\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#\u0060\u0060####\u0060\u0060","title":"Dsl.\u0060\u0060####\u0060\u0060","content":"Dsl.\u0060\u0060####\u0060\u0060 \n\u0060\u0060####\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#\u0060\u0060#####\u0060\u0060","title":"Dsl.\u0060\u0060#####\u0060\u0060","content":"Dsl.\u0060\u0060#####\u0060\u0060 \n\u0060\u0060#####\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#strong","title":"Dsl.strong","content":"Dsl.strong \nstrong \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#p","title":"Dsl.p","content":"Dsl.p \np \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#span","title":"Dsl.span","content":"Dsl.span \nspan \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#(!!)","title":"Dsl.(!!)","content":"Dsl.(!!) \n(!!) \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#link","title":"Dsl.link","content":"Dsl.link \nlink \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#ul","title":"Dsl.ul","content":"Dsl.ul \nul \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#ol","title":"Dsl.ol","content":"Dsl.ol \nol \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#table","title":"Dsl.table","content":"Dsl.table \ntable \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-dsl.html#img","title":"Dsl.img","content":"Dsl.img \nimg \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-htmlformatting.html","title":"HtmlFormatting","content":"HtmlFormatting \n \nHtmlFormatting.formatAsHtml \nformatAsHtml","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-htmlformatting.html#formatAsHtml","title":"HtmlFormatting.formatAsHtml","content":"HtmlFormatting.formatAsHtml \nformatAsHtml \n Format Markdown document and write the result to\n a specified TextWriter. Parameters specify newline character\n and a dictionary with link keys defined in the document.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html","title":"MarkdownPatterns","content":"MarkdownPatterns \n This module provides an easy way of processing Markdown documents.\n It lets you decompose documents into leafs and nodes with nested paragraphs. \nMarkdownPatterns.ParagraphLeafInfo \nParagraphLeafInfo \nMarkdownPatterns.ParagraphNestedInfo \nParagraphNestedInfo \nMarkdownPatterns.ParagraphSpansInfo \nParagraphSpansInfo \nMarkdownPatterns.SpanLeafInfo \nSpanLeafInfo \nMarkdownPatterns.SpanNodeInfo \nSpanNodeInfo \nMarkdownPatterns.SpanLeaf \nSpanLeaf \nMarkdownPatterns.SpanNode \nSpanNode \nMarkdownPatterns.ParagraphSpans \nParagraphSpans \nMarkdownPatterns.ParagraphLeaf \nParagraphLeaf \nMarkdownPatterns.ParagraphNested \nParagraphNested \nMarkdownPatterns.(|SpanLeaf|SpanNode|) \n(|SpanLeaf|SpanNode|) \nMarkdownPatterns.(|ParagraphLeaf|ParagraphNested|ParagraphSpans|) \n(|ParagraphLeaf|ParagraphNested|ParagraphSpans|)","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#SpanLeaf","title":"MarkdownPatterns.SpanLeaf","content":"MarkdownPatterns.SpanLeaf \nSpanLeaf \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#SpanNode","title":"MarkdownPatterns.SpanNode","content":"MarkdownPatterns.SpanNode \nSpanNode \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#ParagraphSpans","title":"MarkdownPatterns.ParagraphSpans","content":"MarkdownPatterns.ParagraphSpans \nParagraphSpans \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#ParagraphLeaf","title":"MarkdownPatterns.ParagraphLeaf","content":"MarkdownPatterns.ParagraphLeaf \nParagraphLeaf \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#ParagraphNested","title":"MarkdownPatterns.ParagraphNested","content":"MarkdownPatterns.ParagraphNested \nParagraphNested \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#(|SpanLeaf|SpanNode|)","title":"MarkdownPatterns.(|SpanLeaf|SpanNode|)","content":"MarkdownPatterns.(|SpanLeaf|SpanNode|) \n(|SpanLeaf|SpanNode|) \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html#(|ParagraphLeaf|ParagraphNested|ParagraphSpans|)","title":"MarkdownPatterns.(|ParagraphLeaf|ParagraphNested|ParagraphSpans|)","content":"MarkdownPatterns.(|ParagraphLeaf|ParagraphNested|ParagraphSpans|) \n(|ParagraphLeaf|ParagraphNested|ParagraphSpans|) \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns-paragraphleafinfo.html","title":"ParagraphLeafInfo","content":"ParagraphLeafInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns-paragraphnestedinfo.html","title":"ParagraphNestedInfo","content":"ParagraphNestedInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns-paragraphspansinfo.html","title":"ParagraphSpansInfo","content":"ParagraphSpansInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns-spanleafinfo.html","title":"SpanLeafInfo","content":"SpanLeafInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns-spannodeinfo.html","title":"SpanNodeInfo","content":"SpanNodeInfo \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html","title":"Markdown","content":"Markdown \n Static class that provides methods for formatting\n and transforming Markdown documents. \nMarkdown.Parse \nParse \nMarkdown.ToFsx \nToFsx \nMarkdown.ToHtml \nToHtml \nMarkdown.ToHtml \nToHtml \nMarkdown.ToLatex \nToLatex \nMarkdown.ToLatex \nToLatex \nMarkdown.ToMd \nToMd \nMarkdown.ToPynb \nToPynb \nMarkdown.WriteHtml \nWriteHtml \nMarkdown.WriteHtml \nWriteHtml \nMarkdown.WriteLatex \nWriteLatex \nMarkdown.WriteLatex \nWriteLatex","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#Parse","title":"Markdown.Parse","content":"Markdown.Parse \nParse \n Parse the specified text into a MarkdownDocument. Line breaks in the\n inline HTML (etc.) will be stored using the specified string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToFsx","title":"Markdown.ToFsx","content":"Markdown.ToFsx \nToFsx \n Transform the provided MarkdownDocument into Fsx and return the result as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToHtml","title":"Markdown.ToHtml","content":"Markdown.ToHtml \nToHtml \n Transform Markdown document into HTML format.\n The result will be returned as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToHtml","title":"Markdown.ToHtml","content":"Markdown.ToHtml \nToHtml \n Transform the provided MarkdownDocument into HTML\n format and return the result as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToLatex","title":"Markdown.ToLatex","content":"Markdown.ToLatex \nToLatex \n Transform Markdown text into LaTeX format. The result will be returned as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToLatex","title":"Markdown.ToLatex","content":"Markdown.ToLatex \nToLatex \n Transform the provided MarkdownDocument into LaTeX\n format and return the result as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToMd","title":"Markdown.ToMd","content":"Markdown.ToMd \nToMd \n Transform the provided MarkdownDocument into Markdown and return the result as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToPynb","title":"Markdown.ToPynb","content":"Markdown.ToPynb \nToPynb \n Transform the provided MarkdownDocument into Pynb and return the result as a string.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#WriteHtml","title":"Markdown.WriteHtml","content":"Markdown.WriteHtml \nWriteHtml \n Transform Markdown text into HTML format. The result\n will be written to the provided TextWriter.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#WriteHtml","title":"Markdown.WriteHtml","content":"Markdown.WriteHtml \nWriteHtml \n Transform the provided MarkdownDocument into HTML\n format and write the result to a given writer.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#WriteLatex","title":"Markdown.WriteLatex","content":"Markdown.WriteLatex \nWriteLatex \n Transform Markdown document into LaTeX format. The result\n will be written to the provided TextWriter.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#WriteLatex","title":"Markdown.WriteLatex","content":"Markdown.WriteLatex \nWriteLatex \n Transform the provided MarkdownDocument into LaTeX\n format and write the result to a given writer.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowncolumnalignment.html","title":"MarkdownColumnAlignment","content":"MarkdownColumnAlignment \n Column in a table can be aligned to left, right, center or using the default alignment \nMarkdownColumnAlignment.AlignLeft \nAlignLeft \nMarkdownColumnAlignment.AlignRight \nAlignRight \nMarkdownColumnAlignment.AlignCenter \nAlignCenter \nMarkdownColumnAlignment.AlignDefault \nAlignDefault","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowncolumnalignment.html#AlignLeft","title":"MarkdownColumnAlignment.AlignLeft","content":"MarkdownColumnAlignment.AlignLeft \nAlignLeft \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowncolumnalignment.html#AlignRight","title":"MarkdownColumnAlignment.AlignRight","content":"MarkdownColumnAlignment.AlignRight \nAlignRight \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowncolumnalignment.html#AlignCenter","title":"MarkdownColumnAlignment.AlignCenter","content":"MarkdownColumnAlignment.AlignCenter \nAlignCenter \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowncolumnalignment.html#AlignDefault","title":"MarkdownColumnAlignment.AlignDefault","content":"MarkdownColumnAlignment.AlignDefault \nAlignDefault \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html","title":"MarkdownDocument","content":"MarkdownDocument \n\n Representation of a Markdown document - the representation of Paragraphs\n uses an F# discriminated union type and so is best used from F#.\n \nMarkdownDocument.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nMarkdownDocument.Paragraphs \nParagraphs \nMarkdownDocument.DefinedLinks \nDefinedLinks","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#\u0060\u0060.ctor\u0060\u0060","title":"MarkdownDocument.\u0060\u0060.ctor\u0060\u0060","content":"MarkdownDocument.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#Paragraphs","title":"MarkdownDocument.Paragraphs","content":"MarkdownDocument.Paragraphs \nParagraphs \n Returns a list of paragraphs in the document","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#DefinedLinks","title":"MarkdownDocument.DefinedLinks","content":"MarkdownDocument.DefinedLinks \nDefinedLinks \n Returns a dictionary containing explicitly defined links","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownembedparagraphs.html","title":"MarkdownEmbedParagraphs","content":"MarkdownEmbedParagraphs \n Provides an extensibility point for adding custom kinds of paragraphs into a document\n (MarkdownEmbedParagraphs values can be embedded using MarkdownParagraph.EmbedParagraphs) \nMarkdownEmbedParagraphs.Render \nRender","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownembedparagraphs.html#Render","title":"MarkdownEmbedParagraphs.Render","content":"MarkdownEmbedParagraphs.Render \nRender \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownembedspans.html","title":"MarkdownEmbedSpans","content":"MarkdownEmbedSpans \n Provides an extensibility point for adding custom kinds of spans into a document\n (MarkdownEmbedSpans values can be embedded using MarkdownSpan.EmbedSpans) \nMarkdownEmbedSpans.Render \nRender","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownembedspans.html#Render","title":"MarkdownEmbedSpans.Render","content":"MarkdownEmbedSpans.Render \nRender \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownlistkind.html","title":"MarkdownListKind","content":"MarkdownListKind \n\n A list kind can be Ordered or Unordered corresponding to \u003Ccode\u003E\u0026lt;ol\u0026gt;\u003C/code\u003E and \u003Ccode\u003E\u0026lt;ul\u0026gt;\u003C/code\u003E elements\n \nMarkdownListKind.Ordered \nOrdered \nMarkdownListKind.Unordered \nUnordered","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownlistkind.html#Ordered","title":"MarkdownListKind.Ordered","content":"MarkdownListKind.Ordered \nOrdered \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownlistkind.html#Unordered","title":"MarkdownListKind.Unordered","content":"MarkdownListKind.Unordered \nUnordered \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html","title":"MarkdownParagraph","content":"MarkdownParagraph \n A paragraph represents a (possibly) multi-line element of a Markdown document.\n Paragraphs are headings, inline paragraphs, code blocks, lists, quotations, tables and\n also embedded LaTeX blocks. \nMarkdownParagraph.Heading \nHeading \nMarkdownParagraph.Paragraph \nParagraph \nMarkdownParagraph.CodeBlock \nCodeBlock \nMarkdownParagraph.InlineHtmlBlock \nInlineHtmlBlock \nMarkdownParagraph.ListBlock \nListBlock \nMarkdownParagraph.QuotedBlock \nQuotedBlock \nMarkdownParagraph.Span \nSpan \nMarkdownParagraph.LatexBlock \nLatexBlock \nMarkdownParagraph.HorizontalRule \nHorizontalRule \nMarkdownParagraph.TableBlock \nTableBlock \nMarkdownParagraph.OtherBlock \nOtherBlock \nMarkdownParagraph.EmbedParagraphs \nEmbedParagraphs \nMarkdownParagraph.YamlFrontmatter \nYamlFrontmatter \nMarkdownParagraph.OutputBlock \nOutputBlock","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#Heading","title":"MarkdownParagraph.Heading","content":"MarkdownParagraph.Heading \nHeading \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#Paragraph","title":"MarkdownParagraph.Paragraph","content":"MarkdownParagraph.Paragraph \nParagraph \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#CodeBlock","title":"MarkdownParagraph.CodeBlock","content":"MarkdownParagraph.CodeBlock \nCodeBlock \n A code block, whether fenced or via indentation","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#InlineHtmlBlock","title":"MarkdownParagraph.InlineHtmlBlock","content":"MarkdownParagraph.InlineHtmlBlock \nInlineHtmlBlock \n A HTML block","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#ListBlock","title":"MarkdownParagraph.ListBlock","content":"MarkdownParagraph.ListBlock \nListBlock \n A Markdown List block","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#QuotedBlock","title":"MarkdownParagraph.QuotedBlock","content":"MarkdownParagraph.QuotedBlock \nQuotedBlock \n A Markdown Quote block","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#Span","title":"MarkdownParagraph.Span","content":"MarkdownParagraph.Span \nSpan \n A Markdown Span block","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#LatexBlock","title":"MarkdownParagraph.LatexBlock","content":"MarkdownParagraph.LatexBlock \nLatexBlock \n A Markdown Latex block","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#HorizontalRule","title":"MarkdownParagraph.HorizontalRule","content":"MarkdownParagraph.HorizontalRule \nHorizontalRule \n A Markdown Horizontal rule","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#TableBlock","title":"MarkdownParagraph.TableBlock","content":"MarkdownParagraph.TableBlock \nTableBlock \n A Markdown Table","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#OtherBlock","title":"MarkdownParagraph.OtherBlock","content":"MarkdownParagraph.OtherBlock \nOtherBlock \n Represents a block of markdown produced when parsing of code or tables or quoted blocks is suppressed","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#EmbedParagraphs","title":"MarkdownParagraph.EmbedParagraphs","content":"MarkdownParagraph.EmbedParagraphs \nEmbedParagraphs \n A special addition for computing paragraphs","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#YamlFrontmatter","title":"MarkdownParagraph.YamlFrontmatter","content":"MarkdownParagraph.YamlFrontmatter \nYamlFrontmatter \n A special addition for YAML-style frontmatter","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraph.html#OutputBlock","title":"MarkdownParagraph.OutputBlock","content":"MarkdownParagraph.OutputBlock \nOutputBlock \n A special addition for inserted outputs","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html","title":"MarkdownParagraphs","content":"MarkdownParagraphs \n A type alias for a list of paragraphs \nMarkdownParagraphs.Item \nItem \nMarkdownParagraphs.IsEmpty \nIsEmpty \nMarkdownParagraphs.Tail \nTail \nMarkdownParagraphs.Length \nLength \nMarkdownParagraphs.Head \nHead \nMarkdownParagraphs.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#Item","title":"MarkdownParagraphs.Item","content":"MarkdownParagraphs.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#IsEmpty","title":"MarkdownParagraphs.IsEmpty","content":"MarkdownParagraphs.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#Tail","title":"MarkdownParagraphs.Tail","content":"MarkdownParagraphs.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#Length","title":"MarkdownParagraphs.Length","content":"MarkdownParagraphs.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#Head","title":"MarkdownParagraphs.Head","content":"MarkdownParagraphs.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparagraphs.html#Empty","title":"MarkdownParagraphs.Empty","content":"MarkdownParagraphs.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparseoptions.html","title":"MarkdownParseOptions","content":"MarkdownParseOptions \n Controls the parsing of markdown \nMarkdownParseOptions.None \nNone \nMarkdownParseOptions.ParseCodeAsOther \nParseCodeAsOther \nMarkdownParseOptions.ParseNonCodeAsOther \nParseNonCodeAsOther \nMarkdownParseOptions.AllowYamlFrontMatter \nAllowYamlFrontMatter","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparseoptions.html#None","title":"MarkdownParseOptions.None","content":"MarkdownParseOptions.None \nNone \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparseoptions.html#ParseCodeAsOther","title":"MarkdownParseOptions.ParseCodeAsOther","content":"MarkdownParseOptions.ParseCodeAsOther \nParseCodeAsOther \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparseoptions.html#ParseNonCodeAsOther","title":"MarkdownParseOptions.ParseNonCodeAsOther","content":"MarkdownParseOptions.ParseNonCodeAsOther \nParseNonCodeAsOther \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownparseoptions.html#AllowYamlFrontMatter","title":"MarkdownParseOptions.AllowYamlFrontMatter","content":"MarkdownParseOptions.AllowYamlFrontMatter \nAllowYamlFrontMatter \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html","title":"MarkdownSpan","content":"MarkdownSpan \n Represents inline formatting inside a paragraph. This can be literal (with text), various\n formattings (string, emphasis, etc.), hyperlinks, images, inline maths etc. \nMarkdownSpan.Literal \nLiteral \nMarkdownSpan.InlineCode \nInlineCode \nMarkdownSpan.Strong \nStrong \nMarkdownSpan.Emphasis \nEmphasis \nMarkdownSpan.AnchorLink \nAnchorLink \nMarkdownSpan.DirectLink \nDirectLink \nMarkdownSpan.IndirectLink \nIndirectLink \nMarkdownSpan.DirectImage \nDirectImage \nMarkdownSpan.IndirectImage \nIndirectImage \nMarkdownSpan.HardLineBreak \nHardLineBreak \nMarkdownSpan.LatexInlineMath \nLatexInlineMath \nMarkdownSpan.LatexDisplayMath \nLatexDisplayMath \nMarkdownSpan.EmbedSpans \nEmbedSpans","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#Literal","title":"MarkdownSpan.Literal","content":"MarkdownSpan.Literal \nLiteral \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#InlineCode","title":"MarkdownSpan.InlineCode","content":"MarkdownSpan.InlineCode \nInlineCode \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#Strong","title":"MarkdownSpan.Strong","content":"MarkdownSpan.Strong \nStrong \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#Emphasis","title":"MarkdownSpan.Emphasis","content":"MarkdownSpan.Emphasis \nEmphasis \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#AnchorLink","title":"MarkdownSpan.AnchorLink","content":"MarkdownSpan.AnchorLink \nAnchorLink \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#DirectLink","title":"MarkdownSpan.DirectLink","content":"MarkdownSpan.DirectLink \nDirectLink \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#IndirectLink","title":"MarkdownSpan.IndirectLink","content":"MarkdownSpan.IndirectLink \nIndirectLink \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#DirectImage","title":"MarkdownSpan.DirectImage","content":"MarkdownSpan.DirectImage \nDirectImage \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#IndirectImage","title":"MarkdownSpan.IndirectImage","content":"MarkdownSpan.IndirectImage \nIndirectImage \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#HardLineBreak","title":"MarkdownSpan.HardLineBreak","content":"MarkdownSpan.HardLineBreak \nHardLineBreak \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#LatexInlineMath","title":"MarkdownSpan.LatexInlineMath","content":"MarkdownSpan.LatexInlineMath \nLatexInlineMath \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#LatexDisplayMath","title":"MarkdownSpan.LatexDisplayMath","content":"MarkdownSpan.LatexDisplayMath \nLatexDisplayMath \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html#EmbedSpans","title":"MarkdownSpan.EmbedSpans","content":"MarkdownSpan.EmbedSpans \nEmbedSpans \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html","title":"MarkdownSpans","content":"MarkdownSpans \n A type alias for a list of MarkdownSpan values \nMarkdownSpans.Item \nItem \nMarkdownSpans.IsEmpty \nIsEmpty \nMarkdownSpans.Tail \nTail \nMarkdownSpans.Length \nLength \nMarkdownSpans.Head \nHead \nMarkdownSpans.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#Item","title":"MarkdownSpans.Item","content":"MarkdownSpans.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#IsEmpty","title":"MarkdownSpans.IsEmpty","content":"MarkdownSpans.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#Tail","title":"MarkdownSpans.Tail","content":"MarkdownSpans.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#Length","title":"MarkdownSpans.Length","content":"MarkdownSpans.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#Head","title":"MarkdownSpans.Head","content":"MarkdownSpans.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspans.html#Empty","title":"MarkdownSpans.Empty","content":"MarkdownSpans.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html","title":"MarkdownTableRow","content":"MarkdownTableRow \n A type alias representing table row as a list of paragraphs \nMarkdownTableRow.Item \nItem \nMarkdownTableRow.IsEmpty \nIsEmpty \nMarkdownTableRow.Tail \nTail \nMarkdownTableRow.Length \nLength \nMarkdownTableRow.Head \nHead \nMarkdownTableRow.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#Item","title":"MarkdownTableRow.Item","content":"MarkdownTableRow.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#IsEmpty","title":"MarkdownTableRow.IsEmpty","content":"MarkdownTableRow.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#Tail","title":"MarkdownTableRow.Tail","content":"MarkdownTableRow.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#Length","title":"MarkdownTableRow.Length","content":"MarkdownTableRow.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#Head","title":"MarkdownTableRow.Head","content":"MarkdownTableRow.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowntablerow.html#Empty","title":"MarkdownTableRow.Empty","content":"MarkdownTableRow.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrangemodule.html","title":"MarkdownRange","content":"MarkdownRange \n \nMarkdownRange.zero \nzero \nMarkdownRange.mergeRanges \nmergeRanges","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrangemodule.html#zero","title":"MarkdownRange.zero","content":"MarkdownRange.zero \nzero \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrangemodule.html#mergeRanges","title":"MarkdownRange.mergeRanges","content":"MarkdownRange.mergeRanges \nmergeRanges \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrange.html","title":"MarkdownRange","content":"MarkdownRange \n \nMarkdownRange.StartLine \nStartLine \nMarkdownRange.StartColumn \nStartColumn \nMarkdownRange.EndLine \nEndLine \nMarkdownRange.EndColumn \nEndColumn","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrange.html#StartLine","title":"MarkdownRange.StartLine","content":"MarkdownRange.StartLine \nStartLine \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrange.html#StartColumn","title":"MarkdownRange.StartColumn","content":"MarkdownRange.StartColumn \nStartColumn \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrange.html#EndLine","title":"MarkdownRange.EndLine","content":"MarkdownRange.EndLine \nEndLine \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownrange.html#EndColumn","title":"MarkdownRange.EndColumn","content":"MarkdownRange.EndColumn \nEndColumn \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html","title":"ParamKeys","content":"ParamKeys \n Defines the parameter keys known to FSharp.Formatting processing code \nParamKeys.root \nroot \nParamKeys.\u0060\u0060fsdocs-authors\u0060\u0060 \n\u0060\u0060fsdocs-authors\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-collection-name\u0060\u0060 \n\u0060\u0060fsdocs-collection-name\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-content\u0060\u0060 \n\u0060\u0060fsdocs-content\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-page-content-list\u0060\u0060 \n\u0060\u0060fsdocs-page-content-list\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-collection-name-link\u0060\u0060 \n\u0060\u0060fsdocs-collection-name-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-copyright\u0060\u0060 \n\u0060\u0060fsdocs-copyright\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-license-link\u0060\u0060 \n\u0060\u0060fsdocs-license-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060 \n\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-list-of-documents\u0060\u0060 \n\u0060\u0060fsdocs-list-of-documents\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-logo-link\u0060\u0060 \n\u0060\u0060fsdocs-logo-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-logo-src\u0060\u0060 \n\u0060\u0060fsdocs-logo-src\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-favicon-src\u0060\u0060 \n\u0060\u0060fsdocs-favicon-src\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-package-license-expression\u0060\u0060 \n\u0060\u0060fsdocs-package-license-expression\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-package-project-url\u0060\u0060 \n\u0060\u0060fsdocs-package-project-url\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-package-tags\u0060\u0060 \n\u0060\u0060fsdocs-package-tags\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-package-version\u0060\u0060 \n\u0060\u0060fsdocs-package-version\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-package-icon-url\u0060\u0060 \n\u0060\u0060fsdocs-package-icon-url\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-page-title\u0060\u0060 \n\u0060\u0060fsdocs-page-title\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-page-source\u0060\u0060 \n\u0060\u0060fsdocs-page-source\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-release-notes-link\u0060\u0060 \n\u0060\u0060fsdocs-release-notes-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-repository-branch\u0060\u0060 \n\u0060\u0060fsdocs-repository-branch\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-repository-commit\u0060\u0060 \n\u0060\u0060fsdocs-repository-commit\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-repository-link\u0060\u0060 \n\u0060\u0060fsdocs-repository-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-source\u0060\u0060 \n\u0060\u0060fsdocs-source\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-source-filename\u0060\u0060 \n\u0060\u0060fsdocs-source-filename\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-source-basename\u0060\u0060 \n\u0060\u0060fsdocs-source-basename\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-theme\u0060\u0060 \n\u0060\u0060fsdocs-theme\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-tooltips\u0060\u0060 \n\u0060\u0060fsdocs-tooltips\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-watch-script\u0060\u0060 \n\u0060\u0060fsdocs-watch-script\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-header-content\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-content\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-header-id\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-id\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-items\u0060\u0060 \n\u0060\u0060fsdocs-menu-items\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-item-link\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-item-content\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-content\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-item-id\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-id\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-previous-page-link\u0060\u0060 \n\u0060\u0060fsdocs-previous-page-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-next-page-link\u0060\u0060 \n\u0060\u0060fsdocs-next-page-link\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-head-extra\u0060\u0060 \n\u0060\u0060fsdocs-head-extra\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-body-extra\u0060\u0060 \n\u0060\u0060fsdocs-body-extra\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-body-class\u0060\u0060 \n\u0060\u0060fsdocs-body-class\u0060\u0060 \nParamKeys.\u0060\u0060fsdocs-meta-tags\u0060\u0060 \n\u0060\u0060fsdocs-meta-tags\u0060\u0060","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#root","title":"ParamKeys.root","content":"ParamKeys.root \nroot \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-authors\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-authors\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-authors\u0060\u0060 \n\u0060\u0060fsdocs-authors\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-collection-name\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-collection-name\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-collection-name\u0060\u0060 \n\u0060\u0060fsdocs-collection-name\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-content\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-content\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-content\u0060\u0060 \n\u0060\u0060fsdocs-content\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-page-content-list\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-page-content-list\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-page-content-list\u0060\u0060 \n\u0060\u0060fsdocs-page-content-list\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-collection-name-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-collection-name-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-collection-name-link\u0060\u0060 \n\u0060\u0060fsdocs-collection-name-link\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-copyright\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-copyright\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-copyright\u0060\u0060 \n\u0060\u0060fsdocs-copyright\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-license-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-license-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-license-link\u0060\u0060 \n\u0060\u0060fsdocs-license-link\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060 \n\u0060\u0060fsdocs-list-of-namespaces\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-list-of-documents\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-list-of-documents\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-list-of-documents\u0060\u0060 \n\u0060\u0060fsdocs-list-of-documents\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-logo-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-logo-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-logo-link\u0060\u0060 \n\u0060\u0060fsdocs-logo-link\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-logo-src\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-logo-src\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-logo-src\u0060\u0060 \n\u0060\u0060fsdocs-logo-src\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-favicon-src\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-favicon-src\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-favicon-src\u0060\u0060 \n\u0060\u0060fsdocs-favicon-src\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-package-license-expression\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-package-license-expression\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-package-license-expression\u0060\u0060 \n\u0060\u0060fsdocs-package-license-expression\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-package-project-url\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-package-project-url\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-package-project-url\u0060\u0060 \n\u0060\u0060fsdocs-package-project-url\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-package-tags\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-package-tags\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-package-tags\u0060\u0060 \n\u0060\u0060fsdocs-package-tags\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-package-version\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-package-version\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-package-version\u0060\u0060 \n\u0060\u0060fsdocs-package-version\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-package-icon-url\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-package-icon-url\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-package-icon-url\u0060\u0060 \n\u0060\u0060fsdocs-package-icon-url\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-page-title\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-page-title\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-page-title\u0060\u0060 \n\u0060\u0060fsdocs-page-title\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-page-source\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-page-source\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-page-source\u0060\u0060 \n\u0060\u0060fsdocs-page-source\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-release-notes-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-release-notes-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-release-notes-link\u0060\u0060 \n\u0060\u0060fsdocs-release-notes-link\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-repository-branch\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-repository-branch\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-repository-branch\u0060\u0060 \n\u0060\u0060fsdocs-repository-branch\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-repository-commit\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-repository-commit\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-repository-commit\u0060\u0060 \n\u0060\u0060fsdocs-repository-commit\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-repository-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-repository-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-repository-link\u0060\u0060 \n\u0060\u0060fsdocs-repository-link\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-source\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-source\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-source\u0060\u0060 \n\u0060\u0060fsdocs-source\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-source-filename\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-source-filename\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-source-filename\u0060\u0060 \n\u0060\u0060fsdocs-source-filename\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-source-basename\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-source-basename\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-source-basename\u0060\u0060 \n\u0060\u0060fsdocs-source-basename\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-theme\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-theme\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-theme\u0060\u0060 \n\u0060\u0060fsdocs-theme\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-tooltips\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-tooltips\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-tooltips\u0060\u0060 \n\u0060\u0060fsdocs-tooltips\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-watch-script\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-watch-script\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-watch-script\u0060\u0060 \n\u0060\u0060fsdocs-watch-script\u0060\u0060 \n A parameter key known to FSharp.Formatting","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-header-content\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-header-content\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-header-content\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-content\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-header-id\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-header-id\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-header-id\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-id\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060 \n\u0060\u0060fsdocs-menu-header-active-class\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu_template.html\n This will be an empty string if the category is not active.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-items\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-items\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-items\u0060\u0060 \n\u0060\u0060fsdocs-menu-items\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-item-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-item-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-item-link\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-link\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu-item_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-item-content\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-item-content\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-item-content\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-content\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu-item_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-item-id\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-item-id\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-item-id\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-id\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu-item_template.html","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060 \n\u0060\u0060fsdocs-menu-item-active-class\u0060\u0060 \n A parameter key known to FSharp.Formatting, available in _menu-item_template.html\n /// This will be an empty string if the item is not active.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-previous-page-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-previous-page-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-previous-page-link\u0060\u0060 \n\u0060\u0060fsdocs-previous-page-link\u0060\u0060 \n A parameter key known to FSharp.Formatting, available when frontmatter is used correctly","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-next-page-link\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-next-page-link\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-next-page-link\u0060\u0060 \n\u0060\u0060fsdocs-next-page-link\u0060\u0060 \n A parameter key known to FSharp.Formatting, available when frontmatter is used correctly","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-head-extra\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-head-extra\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-head-extra\u0060\u0060 \n\u0060\u0060fsdocs-head-extra\u0060\u0060 \n A parameter key known to FSharp.Formatting, available when \u0060_head.html\u0060 exists in the input folder.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-body-extra\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-body-extra\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-body-extra\u0060\u0060 \n\u0060\u0060fsdocs-body-extra\u0060\u0060 \n A parameter key known to FSharp.Formatting, available when \u0060_head.html\u0060 exists in the input folder.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-body-class\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-body-class\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-body-class\u0060\u0060 \n\u0060\u0060fsdocs-body-class\u0060\u0060 \n A parameter key known to FSharp.Formatting, either \u0027content\u0027 or \u0027api-doc\u0027\n Mean to be used on the \u0060class\u0060 attribute in the \u0060\u003Cbody\u003E\u0060 tag.\n This helps to differentiate styles between API docs and custom content.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkeys.html#\u0060\u0060fsdocs-meta-tags\u0060\u0060","title":"ParamKeys.\u0060\u0060fsdocs-meta-tags\u0060\u0060","content":"ParamKeys.\u0060\u0060fsdocs-meta-tags\u0060\u0060 \n\u0060\u0060fsdocs-meta-tags\u0060\u0060 \n A parameter key known to FSharp.Formatting, it is HTML composed from additional frontmatter information.\n Such as tags and description\n This can be empty when both properties are not provided for the current page.","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html","title":"FrontMatterFile","content":"FrontMatterFile \n Meta data from files that contains front matter\n Used to determine upfront which files have front matter so that previous and next substitutes can be discovered. \nFrontMatterFile.ParseFromLines \nParseFromLines \nFrontMatterFile.FileName \nFileName \nFrontMatterFile.Category \nCategory \nFrontMatterFile.CategoryIndex \nCategoryIndex \nFrontMatterFile.Index \nIndex","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html#ParseFromLines","title":"FrontMatterFile.ParseFromLines","content":"FrontMatterFile.ParseFromLines \nParseFromLines \n Parses the category, categoryindex and index from the frontmatter lines","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html#FileName","title":"FrontMatterFile.FileName","content":"FrontMatterFile.FileName \nFileName \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html#Category","title":"FrontMatterFile.Category","content":"FrontMatterFile.Category \nCategory \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html#CategoryIndex","title":"FrontMatterFile.CategoryIndex","content":"FrontMatterFile.CategoryIndex \nCategoryIndex \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-frontmatterfile.html#Index","title":"FrontMatterFile.Index","content":"FrontMatterFile.Index \nIndex \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkey.html","title":"ParamKey","content":"ParamKey \n\n A parameter key\n \nParamKey.ParamKey \nParamKey","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-paramkey.html#ParamKey","title":"ParamKey.ParamKey","content":"ParamKey.ParamKey \nParamKey \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html","title":"Substitutions","content":"Substitutions \n A list of parameters for substituting in templates, indexed by parameter keys \nSubstitutions.Item \nItem \nSubstitutions.IsEmpty \nIsEmpty \nSubstitutions.Tail \nTail \nSubstitutions.Length \nLength \nSubstitutions.Head \nHead \nSubstitutions.Empty \nEmpty","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#Item","title":"Substitutions.Item","content":"Substitutions.Item \nItem \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#IsEmpty","title":"Substitutions.IsEmpty","content":"Substitutions.IsEmpty \nIsEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#Tail","title":"Substitutions.Tail","content":"Substitutions.Tail \nTail \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#Length","title":"Substitutions.Length","content":"Substitutions.Length \nLength \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#Head","title":"Substitutions.Head","content":"Substitutions.Head \nHead \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-templating-substitutions.html#Empty","title":"Substitutions.Empty","content":"Substitutions.Empty \nEmpty \n","headings":[],"type":"apiDocs"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/apidocs.html","title":"Generating API Docs","content":"\n\u0026emsp;\n\u0026emsp;\n\nAPI Documentation Generation\nThe command-line tool fsdocs can be used to generate documentation\nfor F# libraries with XML comments. The documentation is normally built using fsdocs build and developed using fsdocs watch. For\nthe former the output will be placed in output\\reference by default.\nSelected projects\nfsdocs automatically selects the projects and \u0022cracks\u0022 the project files for information\n\nProjects with GenerateDocumentationFile and without IsTestProject are selected.\nIf Projects use TargetFrameworks (not TargetFramework, singular) only the firts target framework will be used to build the docs.\n\n \u0026lt;PropertyGroup\u0026gt;\n \u0026lt;GenerateDocumentationFile\u0026gt;true\u0026lt;/GenerateDocumentationFile\u0026gt;\n \u0026lt;/PropertyGroup\u0026gt;\n\nTemplates\nThe HTML is built by instantiating a template. The template used is the first of:\n\ndocs/reference/_template.html\ndocs/_template.html\nThe default template\n\nUsually, the same template can be used as for other content.\nClassic XML Doc Comments\nXML Doc Comments may use the normal F# and C# XML doc standards.\nThe tags that form the core of the XML doc specification are:\n\u0026lt;c\u0026gt;\t\u0026lt;para\u0026gt;\t\u0026lt;see\u0026gt;*\t\u0026lt;value\u0026gt;\n\u0026lt;code\u0026gt;\t\u0026lt;param\u0026gt;*\t\u0026lt;seealso\u0026gt;*\n\u0026lt;example\u0026gt;\t\u0026lt;paramref\u0026gt;\t\u0026lt;summary\u0026gt;\n\u0026lt;exception\u0026gt;*\t\u0026lt;permission\u0026gt;*\t\u0026lt;typeparam\u0026gt;*\n\u0026lt;include\u0026gt;*\t\u0026lt;remarks\u0026gt;\t\u0026lt;typeparamref\u0026gt;\n\u0026lt;list\u0026gt;\t\u0026lt;inheritdoc\u0026gt;\t\u0026lt;returns\u0026gt;\n\nIn addition, you may also use the Recommended XML doc extensions for F# documentation tooling.\n\n\u0026lt;a href = \u0022...\u0022\u0026gt; links\nArbitrary paragraph-level HTML such as \u0026lt;b\u0026gt; for bold in XML doc text\n\u0026lt;namespacedoc\u0026gt; giving documentation for the enclosing namespace\n\u0026lt;exclude/\u0026gt; to exclude from XML docs\n\n\u0026lt;category\u0026gt; to give a category for an entity or member. An optional index attribute can be specified\nto help sort the list of categories.\n\n\n\\(...\\) for inline math and $$...$$ and \\[...\\]for math environments, see \u003Ca href=\u0022http://docs.mathjax.org.\nSome\u0022\u003Ehttp://docs.mathjax.org.\nSome escaping of characters (e.g. \u0026amp;lt;, \u0026amp;gt;) may be needed to form valid XML\n\n\nAn example of an XML documentation comment, assuming the code is in the namespace TheNamespace:\n/// \u0026lt;summary\u0026gt;\n/// A module\n/// \u0026lt;/summary\u0026gt;\n///\n/// \u0026lt;namespacedoc\u0026gt;\n/// \u0026lt;summary\u0026gt;A namespace to remember\u0026lt;/summary\u0026gt;\n///\n/// \u0026lt;remarks\u0026gt;More on that\u0026lt;/remarks\u0026gt;\n/// \u0026lt;/namespacedoc\u0026gt;\n///\nmodule SomeModule =\n /// \u0026lt;summary\u0026gt;\n /// Some actual comment\n /// \u0026lt;para\u0026gt;Another paragraph, see \u0026lt;see cref=\u0026quot;T:TheNamespace.SomeType\u0026quot;/\u0026gt;. \u0026lt;/para\u0026gt;\n /// \u0026lt;/summary\u0026gt;\n ///\n /// \u0026lt;param name=\u0026quot;x\u0026quot;\u0026gt;The input\u0026lt;/param\u0026gt;\n ///\n /// \u0026lt;returns\u0026gt;The output\u0026lt;/returns\u0026gt;\n ///\n /// \u0026lt;example\u0026gt;\n /// Try using\n /// \u0026lt;code\u0026gt;\n /// open TheNamespace\n /// SomeModule.a\n /// \u0026lt;/code\u0026gt;\n /// \u0026lt;/example\u0026gt;\n ///\n /// \u0026lt;category\u0026gt;Foo\u0026lt;/category\u0026gt;\n let someFunction x = 42 \u002B x\n\n/// \u0026lt;summary\u0026gt;\n/// A type, see \u0026lt;see cref=\u0026quot;T:TheNamespace.SomeModule\u0026quot;/\u0026gt; and\n/// \u0026lt;see cref=\u0026quot;M:TheNamespace.SomeModule.someFunction\u0026quot;/\u0026gt;.\n/// \u0026lt;/summary\u0026gt;\n///\ntype SomeType() =\n member x.P = 1\n\nLike types, members are referred to by xml doc sig. These must currently be precise as the F#\ncompiler doesn\u0027t elaborate these references from simpler names:\ntype Class2() =\n member this.Property = \u0026quot;more\u0026quot;\n member this.Method0() = \u0026quot;more\u0026quot;\n member this.Method1(c: string) = \u0026quot;more\u0026quot;\n member this.Method2(c: string, o: obj) = \u0026quot;more\u0026quot;\n\n/// \u0026lt;see cref=\u0026quot;P:TheNamespace.Class2.Property\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;M:TheNamespace.Class2.OtherMethod0\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;M:TheNamespace.Class2.Method1(System.String)\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;M:TheNamespace.Class2.Method2(System.String,System.Object)\u0026quot; /\u0026gt;\nlet referringFunction1 () = \u0026quot;result\u0026quot;\n\nGeneric types are referred to by .NET compiled name, e.g.\ntype GenericClass2\u0026lt;\u0026#39;T\u0026gt;() =\n member this.Property = \u0026quot;more\u0026quot;\n\n member this.NonGenericMethod(_c: \u0026#39;T) = \u0026quot;more\u0026quot;\n\n member this.GenericMethod(_c: \u0026#39;T, _o: \u0026#39;U) = \u0026quot;more\u0026quot;\n\n/// See \u0026lt;see cref=\u0026quot;T:TheNamespace.GenericClass2\u00601\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;P:TheNamespace.GenericClass2\u00601.Property\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;M:TheNamespace.GenericClass2\u00601.NonGenericMethod(\u00600)\u0026quot; /\u0026gt;\n/// and \u0026lt;see cref=\u0026quot;M:TheNamespace.GenericClass2\u00601.GenericMethod\u0060\u00601(\u00600,\u0060\u00600)\u0026quot; /\u0026gt;\nlet referringFunction2 () = \u0026quot;result\u0026quot;\n\nCross-referencing with \u0026lt;seealso\u0026gt;\nUse \u0026lt;seealso cref=\u0022...\u0022/\u0026gt; within \u0026lt;summary\u0026gt; to create cross-references.\nFor example:\nmodule Forest =\n\n /// \u0026lt;summary\u0026gt;\n /// Find at most \u0026lt;c\u0026gt;limit\u0026lt;/c\u0026gt; foxes in current forest\n ///\n /// See also: \u0026lt;seealso cref=\u0026quot;M:App.Forest.findSquirrels(System.Int32)\u0026quot;/\u0026gt;\n /// \u0026lt;/summary\u0026gt;\n let findFoxes (limit : int) = []\n\n /// \u0026lt;summary\u0026gt;\n /// Find at most \u0026lt;c\u0026gt;limit\u0026lt;/c\u0026gt; squirrels in current forest\n ///\n /// See also: \u0026lt;seealso cref=\u0026quot;M:App.Forest.findFoxes(System.Int32)\u0026quot;/\u0026gt;\n /// \u0026lt;/summary\u0026gt;\n let findSquirrels (limit : int) = []\n\nYou can find the correct value for cref in the generated .xml documentation file (this will be generated alongside the assembly\u0027s .dll\u0060).\nYou can also omit the cref\u0027s arguments, and fsdocs will make an attempt to find the first member that matches.\nFor example:\n /// See also: \u0026lt;seealso cref=\u0026quot;M:App.Forest.findSquirrels\u0026quot;/\u0026gt;\n\nIf the member cannot be found, a link to the containing module/type will be used instead.\nClassic XMl Doc Comments: Excluding APIs from the docs\nIf you want to exclude modules or functions from the API docs, you can use the \u0026lt;exclude/\u0026gt; tag.\nIt needs to be set on a separate triple-slashed line, and can either appear on its own or as part\nof an existing \u0026lt;summary\u0026gt; (for example, you may wish to hide existing documentation while it\u0027s in progress).\nThe \u0026lt;exclude/\u0026gt; tag can be the first or last line in these cases.\nSome examples:\n/// \u0026lt;exclude/\u0026gt;\nmodule BottleKids1 =\n let a = 42\n\n// Ordinary comment\n/// \u0026lt;exclude/\u0026gt;\nmodule BottleKids2 =\n let a = 43\n\n/// \u0026lt;exclude/\u0026gt;\n/// BottleKids3 provides improvements over BottleKids2\nmodule BottleKids3 =\n let a = 44\n\n/// BottleKids4 implements several new features over BottleKids3\n/// \u0026lt;exclude/\u0026gt;\nmodule BottleKids4 =\n let a = 45\n\n/// \u0026lt;exclude/\u0026gt;\n/// \u0026lt;summary\u0026gt;\n/// BottleKids5 is all you\u0026#39;ll ever need in terms of bottles or kids.\n/// \u0026lt;/summary\u0026gt;\nmodule BottleKids5 =\n let a = 46\n\nNote that the comments for BottleKids3 (and BottleKids4) will generate a warning. This is because\nthe \u0026lt;exclude/\u0026gt; tag will be parsed as part of the summary text, and so the documentation generator\ncan\u0027t be completely sure you meant to exclude the item, or whether it was a valid part of the documentation.\nIt will assume the exclusion was intended, but you may want to use explicit \u0026lt;summary\u0026gt; tags to remove\nthe warning.\nThe warning will be of the following format:\nWarning: detected \u0026quot;\u0026lt;exclude/\u0026gt;\u0026quot; in text of \u0026quot;\u0026lt;summary\u0026gt;\u0026quot; for \u0026quot;M:YourLib.BottleKids4\u0026quot;. Please see https://fsprojects.github.io/FSharp.Formatting/apidocs.html#Classic-XML-Doc-Comments\n\nYou will find that [omit] also works, but is considered part of the Markdown syntax and is\ndeprecated for XML Doc comments. This will also produce a warning, such as this:\nThe use of \u0060[omit]\u0060 and other commands in XML comments is deprecated, please use XML extensions, see https://github.com/fsharp/fslang-design/blob/master/tooling/FST-1031-xmldoc-extensions.md\n\nGo to Source links\n\u0027fsdocs\u0027 normally automatically adds GitHub links to each functions, values and class members for further reference.\nThis is normally done automatically based on the following settings:\n \u0026lt;RepositoryUrl\u0026gt;https://github.com/...\u0026lt;/RepositoryUrl\u0026gt;\n \u0026lt;RepositoryBranch\u0026gt;...\u0026lt;/RepositoryBranch\u0026gt;\n \u0026lt;RepositoryType\u0026gt;git\u0026lt;/RepositoryType\u0026gt;\n\nIf your source is not built from the same project where you are building documentation then\nyou may need these settings:\n \u0026lt;FsDocsSourceRepository\u0026gt;...\u0026lt;/FsDocsSourceRepository\u0026gt; -- the URL for the root of the source\n \u0026lt;FsDocsSourceFolder\u0026gt;...\u0026lt;/FsDocsSourceFolder\u0026gt; -- the root soure folder at time of build\n\nIt is assumed that sourceRepo and sourceFolder have synchronized contents.\nMarkdown Comments\nYou can use Markdown instead of XML in /// comments. If you do, you should set \u0026lt;UsesMarkdownComments\u0026gt;true\u0026lt;/UsesMarkdownComments\u0026gt; in\nyour F# project file.\n\nNote: Markdown Comments are not supported in all F# IDE tooling.\n\nAdding cross-type links to modules and types in the same assembly\nYou can automatically add cross-type links to the documentation pages of other modules and types in the same assembly.\nYou can do this in two different ways:\n\n\nAdd a markdown inline link were the link\ntitle is the name of the type you want to link.\n/// This will generate a link to [Foo.Bar] documentation\n\n\n\nAdd a Markdown inline code (using\nback-ticks) where the code is the name of the type you want to link.\n/// This will also generate a link to \u0060Foo.Bar\u0060 documentation\n\n\n\nYou can use either the full name (including namespace and module) or the simple name of a type.\nIf more than one type is found with the same name, the link will not be generated.\nIf a type with the given name is not found in the same assembly, the link will not be generated.\n/// Contains two types [Bar] and [Foo.Baz]\nmodule Foo =\n\n /// Bar is just an \u0060int\u0060 and belongs to module [Foo]\n type Bar = int\n\n /// Baz contains a \u0060Foo.Bar\u0060 as its \u0060id\u0060\n type Baz = { id: Bar }\n\n /// This function operates on \u0060Baz\u0060 types.\n let f (b: Baz) = b.id * 42\n\n/// Referencing [Foo3] will not generate a link as there is no type with the name \u0060Foo3\u0060\nmodule Foo3 =\n\n /// This is not the same type as \u0060Foo.Bar\u0060\n type Bar = double\n\n /// Using the simple name for [Bar] will fail to create a link because the name is duplicated in\n /// [Foo.Bar] and in [Foo3.Bar]. In this case, using the full name works.\n let f2 b = b * 50\n\nMarkdown Comments: Excluding APIs from the docs\nIf you want to exclude modules or functions from the API docs you can use the [omit] tag.\nIt needs to be set on a separate triple-slashed line, but it could be either the first or the last:\nExample as last line:\n/// Some actual comment\n/// [omit]\nmodule Bar =\n let a = 42\n\nExample as the first line:\n/// [omit]\n/// Some actual comment\nmodule Bar2 =\n let a = 42\n\nBuilding library documentation programmatically\nYou can build library documentation programmatically using the functionality\nin the ApiDocs type. To do this, load the assembly and open the necessary namespaces:\n#r \u0026quot;FSharp.Formatting.ApiDocs.dll\u0026quot;\n\nopen FSharp.Formatting.ApiDocs\nopen System.IO\n\nFor example the ApiDocs.GenerateHtml method:\nlet file = Path.Combine(root, \u0026quot;bin/YourLibrary.dll\u0026quot;)\n\nlet input = ApiDocInput.FromFile(file)\n\nApiDocs.GenerateHtml(\n [ input ],\n output = Path.Combine(root, \u0026quot;output\u0026quot;),\n collectionName = \u0026quot;YourLibrary\u0026quot;,\n template = Path.Combine(root, \u0026quot;templates\u0026quot;, \u0026quot;template.html\u0026quot;),\n substitutions = []\n)\n\nAdding extra dependencies\nWhen building a library programmatically, you might require a reference to an additional assembly.\nYou can pass this using the otherFlags argument.\nlet projectAssembly = Path.Combine(root, \u0026quot;bin/X.dll\u0026quot;)\n\nlet projectInput = ApiDocInput.FromFile(projectAssembly)\n\nApiDocs.GenerateHtml(\n [ projectInput ],\n output = Path.Combine(root, \u0026quot;output\u0026quot;),\n collectionName = \u0026quot;Project X\u0026quot;,\n template = Path.Combine(root, \u0026quot;templates\u0026quot;, \u0026quot;template.html\u0026quot;),\n substitutions = [],\n otherFlags = [ \u0026quot;-r:/root/ProjectY/bin/Debug/net6.0/Y.dll\u0026quot; ]\n)\n\nor use libDirs to include all assemblies from an entire folder.\nTip: A combination of \u0026lt;CopyLocalLockFileAssemblies\u0026gt;true\u0026lt;/CopyLocalLockFileAssemblies\u0026gt; in the fsproj file and setting libDirs to the compilation output path leads to only one folder with all dependencies referenced.\nThis might be easier, especially for large projects with many dependencies.\nApiDocs.GenerateHtml(\n [ projectInput ],\n output = Path.Combine(root, \u0026quot;output\u0026quot;),\n collectionName = \u0026quot;Project X\u0026quot;,\n template = Path.Combine(root, \u0026quot;templates\u0026quot;, \u0026quot;template.html\u0026quot;),\n substitutions = [],\n libDirs = [ \u0026quot;ProjectX/bin/Debug/netstandard2.0\u0026quot; ]\n)\n\nRebasing Links\nThe root parameter is used for the base of page and image links in the generated documentation. By default, it is derived from the project\u0027s \u0026lt;PackageProjectUrl\u0026gt; property.\nIn some instances, you may wish to override the value for root (perhaps for local testing). To do this, you can use the command-line argument --parameters root \u0026lt;base\u0026gt;.\nFor example:\ndotnet fsdocs build --output public/docs --parameters root ../\n\n","headings":["API Documentation Generation","Selected projects","Templates","Classic XML Doc Comments","Cross-referencing with \u0026lt;seealso\u0026gt;","Classic XMl Doc Comments: Excluding APIs from the docs","Go to Source links","Markdown Comments","Adding cross-type links to modules and types in the same assembly","Markdown Comments: Excluding APIs from the docs","Building library documentation programmatically","Adding extra dependencies","Rebasing Links"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/evaluation.html","title":"Embedding script output\n","content":"\n\u0026emsp;\n\u0026emsp;\n\nEmbedding script output\nFor literate F# scripts, you may embed the result of running the script as part of the literate output.\nThis is a feature of the functions discussed in literate programming and\nit is implemented using the F# Compiler service.\nIncluding Console Output\nTo include the Console output use include-output:\nlet test = 40 \u002B 2\n\nprintf \u0026quot;A result is: %d\u0026quot; test\n(*** include-output ***)\n\nThe script defines a variable test and then prints it. The console output is included\nin the output.\nTo include the a formatted value use include-it:\n[ 0 .. 99 ]\n\n(*** include-it ***)\n\nTo include the meta output of F# Interactive processing such as type signatures use (*** include-fsi-output ***):\nlet test = 40 \u002B 3\n\n(*** include-fsi-output ***)\n\nTo include both console output and F# Interactive output blended use (*** include-fsi-merged-output ***).\nlet test = 40 \u002B 4\n(*** include-fsi-merged-output ***)\n\nYou can use the same commands with a named snippet:\n(*** include-it: test ***)\n(*** include-fsi-output: test ***)\n(*** include-output: test ***)\n\nYou can use the include-value command to format a specific value:\nlet value1 = [ 0 .. 50 ]\nlet value2 = [ 51 .. 100 ]\n(*** include-value: value1 ***)\n\nUsing AddPrinter and AddHtmlPrinter\nYou can use fsi.AddPrinter, fsi.AddPrintTransformer and fsi.AddHtmlPrinter to extend the formatting of objects.\nEmitting Raw Text\nTo emit raw text in F# literate scripts use the following:\n(**\n\t(*** raw ***)\n\tSome raw text.\n*)\n\nwhich would emit\n\nSome raw text.\n\ndirectly into the document.\nF# Formatting as a Library: Specifying the Evaluator and Formatting\nIf using F# Formatting as a library the embedding of F# output requires specifying an additional parameter to the\nparsing functions discussed in literate programming documentation.\nAssuming you have all the references in place, you can now create an instance of\nFsiEvaluator that represents a wrapper for F# interactive and pass it to all the\nfunctions that parse script files or process script files:\nopen FSharp.Formatting.Literate\nopen FSharp.Formatting.Literate.Evaluation\nopen FSharp.Formatting.Markdown\n\n// Sample literate content\nlet content =\n \u0026quot;\u0026quot;\u0026quot;\nlet a = 10\n(*** include-value:a ***)\u0026quot;\u0026quot;\u0026quot;\n\n// Create evaluator and parse script\nlet fsi = FsiEvaluator()\n\nlet doc = Literate.ParseScriptString(content, fsiEvaluator = fsi)\n\nLiterate.ToHtml(doc)\n\nWhen the fsiEvaluator parameter is specified, the script is evaluated and so you\ncan use additional commands such as include-value. When the evaluator is not specified,\nit is not created automatically, so the functionality is not available (this way,\nyou won\u0027t accidentally run unexpected code!)\nIf you specify the fsiEvaluator parameter, but don\u0027t want a specific snippet to be evaluated\n(because it might throw an exception, for example), you can use the (*** do-not-eval ***)\ncommand.\nThe constructor of FsiEvaluator takes command line parameters for fsi.exe that can\nbe used to specify, for example, defined symbols and other attributes for F# Interactive.\nYou can also subscribe to the EvaluationFailed event which is fired whenever the evaluation\nof an expression fails. You can use that to do tests that verify that all of the code in your\ndocumentation executes without errors.\nF# Formatting as a Library: Custom formatting functions\nAs mentioned earlier, values are formatted using a simple \u0022%A\u0022 formatter by default.\nHowever, you can specify a formatting function that provides nicer formatting for values\nof certain types. For example, let\u0027s say that we would want to format F# lists such as\n[1; 2; 3] as HTML ordered lists \u0026lt;ol\u0026gt;.\nThis can be done by calling FsiEvaluator.RegisterTransformation on the FsiEvaluator instance:\n// Create evaluator \u0026amp; register simple formatter for lists\nlet fsiEvaluator = FsiEvaluator()\n\nfsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) -\u0026gt;\n // If the type of value is an F# list, format it nicely\n if ty.IsGenericType\n \u0026amp;\u0026amp; ty.GetGenericTypeDefinition() = typedefof\u0026lt;list\u0026lt;_\u0026gt;\u0026gt; then\n let items =\n // Get items as objects and create a paragraph for each item\n [ for it in Seq.cast\u0026lt;obj\u0026gt; (unbox o) -\u0026gt; [ Paragraph([ Literal(it.ToString(), None) ], None) ] ]\n // Return option value (success) with ordered list\n Some [ ListBlock(MarkdownListKind.Ordered, items, None) ]\n else\n None)\n\nThe function is called with two arguments - o is the value to be formatted, and ty\nis the static type of the value (as inferred by the F# compiler). The sample checks\nthat the type of the value is a list (containing values of any type), and then it\ncasts all values in the list to obj (for simplicity). Then, we generate Markdown\nblocks representing an ordered list. This means that the code will work for both\nLaTeX and HTML formatting - but if you only need one, you can simply produce HTML and\nembed it in InlineHtmlBlock.\nTo use the new FsiEvaluator, we can use the same style as earlier. This time, we format\na simple list containing strings:\nlet listy =\n \u0026quot;\u0026quot;\u0026quot;\n### Formatting demo\nlet test = [\u0026quot;one\u0026quot;;\u0026quot;two\u0026quot;;\u0026quot;three\u0026quot;]\n(*** include-value:test ***)\u0026quot;\u0026quot;\u0026quot;\n\nlet docOl = Literate.ParseScriptString(listy, fsiEvaluator = fsiEvaluator)\n\nLiterate.ToHtml(docOl)\n\nThe resulting HTML formatting of the document contains the snippet that defines test,\nfollowed by a nicely formatted ordered list:\n\nFormatting demo\n\n1: \n\n\n\nlet test = [\u0026quot;one\u0026quot;;\u0026quot;two\u0026quot;;\u0026quot;three\u0026quot;]\n\n\n\n\none\ntwo\nthree\n\n\n","headings":["Embedding script output","Including Console Output","Using AddPrinter and AddHtmlPrinter","Emitting Raw Text","F# Formatting as a Library: Specifying the Evaluator and Formatting","F# Formatting as a Library: Custom formatting functions"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/styling.html","title":"Customization and Styling\n","content":"\nCustomization and Styling\nWhen using fsdocs, there are six levels of extra content development and styling.\n\n\nDon\u0027t do any styling or documentation customization and simply write content. This is by far the simplest option to\nmaintain.\n\n\nAdd content such as an docs/index.md to customize the front-page content for your generated docs.\nYou can also add content such as docs/reference/fslib.md to give a bespoke landing page\nfor one of your namespaces, e.g. here assumed to be namespace FsLib. This will override any\ngenerated content.\n\nCustomize via Styling Parameters\nCustomize via CSS\nCustomize via a new template\nCustomize by generating your own site using your own code\n\nBy default fsdocs does no styling customization and uses the following defaults. These are the settings used to build\nthis site.\n\n\nUses the default template\nin docs/_template.html\n\n\nUses the default styles\nin docs/content/fsdocs-default.css.\n\n\nUses no custom styles\nin docs/content/fsdocs-custom.css.\n\nUses no styling parameters except those extracted from the project files.\n\nFor your project, you don\u0027t need any of these files. However, you can add them if you wish, though if\nyou adjust them there is no guarantee that your template will continue to work with future versions of F# Formatting.\nCustomizing via Styling Parameters\nThe following content parameters are particularly related to visual styling:\n\n\n\nSubstitution name\nValue (if not overriden by --parameters)\n\n\n\n\nfsdocs-authors\n\u0026lt;Authors\u0026gt;\n\n\nfsdocs-license-link\n\u0026lt;FsDocsLicenseLink\u0026gt;\n\n\nfsdocs-logo-src\n\u0026lt;FsDocsLogoSource\u0026gt;\n\n\nfsdocs-favicon-src\n\u0026lt;FsDocsFaviconSource\u0026gt;\n\n\nfsdocs-logo-link\n\u0026lt;FsDocsLogoLink\u0026gt;\n\n\nfsdocs-release-notes-link\n\u0026lt;FsDocsReleaseNotesLink\u0026gt; else \u0026lt;PackageProjectUrl\u0026gt;/blob/master/RELEASE_NOTES.md\n\n\nfsdocs-repository-link\n\u0026lt;RepositoryUrl\u0026gt;\n\n\nfsdocs-theme\n\u0026lt;FsDocsTheme\u0026gt;, must currently be default\n\n\n\n\nThese basic entry-level styling parameters can be set in the project file or Directory.Build.props.\nFor example:\n\u0026lt;PropertyGroup\u0026gt;\n \u0026lt;!-- Example ultra-simple styling and generation settings for FsDocs default template--\u0026gt;\n \u0026lt;PackageLicenseUrl\u0026gt;https://github.com/foo/bar/blob/master/License.txt\u0026lt;/PackageLicenseUrl\u0026gt;\n \u0026lt;PackageProjectUrl\u0026gt;https://foo.github.io/bar/\u0026lt;/PackageProjectUrl\u0026gt;\n \u0026lt;RepositoryUrl\u0026gt;https://github.com/foo/bar/\u0026lt;/RepositoryUrl\u0026gt;\n \u0026lt;FsDocsLogoLink\u0026gt;https://fsharp.org\u0026lt;/FsDocsLogoLink\u0026gt;\n \u0026lt;FsDocsLogoSource\u0026gt;img/logo.png\u0026lt;/FsDocsLogoSource\u0026gt;\n \u0026lt;FsDocsFaviconSource\u0026gt;img/favicon.ico\u0026lt;/FsDocsFaviconSource\u0026gt;\n \u0026lt;FsDocsLicenseLink\u0026gt;https://github.com/foo/bar/blob/master/License.txt\u0026lt;/FsDocsLicenseLink\u0026gt;\n \u0026lt;FsDocsReleaseNotesLink\u0026gt;https://github.com/foo/bar/blob/master/release-notes.md\u0026lt;/FsDocsReleaseNotesLink\u0026gt;\n \u0026lt;FsDocsWarnOnMissingDocs\u0026gt;true\u0026lt;/FsDocsWarnOnMissingDocs\u0026gt;\n \u0026lt;FsDocsTheme\u0026gt;default\u0026lt;/FsDocsTheme\u0026gt;\n\u0026lt;/PropertyGroup\u0026gt;\n\nAs an example, here is a page with alternative styling.\nCustomizing via CSS\nYou can start styling by creating a file docs/content/fsdocs-theme.css and adding entries to it.\nIt is loaded by the standard template.\nCSS variables\nThe default template is heavily based\non CSS variables. These can easily be\noverride to customize the look and feel of the default theme.\nA full list of the overrideable variables can be\nfound here.\n:root {\n --text-color: red;\n}\n\n[data-theme=dark] {\n --text-color: darkred;\n}\n\nPlease be aware that the dark mode in the default theme is using the same variables.\nWhen you override a variable, it will also be used in dark mode unless redefined in a [data-theme=dark] CSS query.\nCSS classes\nThe API documentation uses a set of fixed CSS classes:\n\n\n\nCSS class\nCorresponding Content\n\n\n\n\n.fsdocs-tip\ngenerated tooltips\n\n\n.fsdocs-xmldoc\ngenerated xmldoc sections\n\n\n.fsdocs-member-list\ngenerated member lists (tables)\n\n\n.fsdocs-member-usage\nusage in generated member lists\n\n\n.fsdocs-member-tooltip\ntooltips in generated member lists\n\n\n.fsdocs-member-xmldoc\ndocumentation in generated member lists\n\n\n.fsdocs-entity-list\ngenerated entity lists\n\n\n.fsdocs-entity-name\ngenerated entity lists\n\n\n.fsdocs-entity-xmldoc\ndocumentation in generated entity lists\n\n\n.fsdocs-exception-list\ngenerated exception lists\n\n\n.fsdocs-summary\nthe \u0027summary\u0027 section of an XML doc\n\n\n.fsdocs-remarks\nthe \u0027remarks\u0027 section of an XML doc\n\n\n.fsdocs-params\nthe \u0027parameters\u0027 section of an XML doc\n\n\n.fsdocs-param\na \u0027parameter\u0027 section of an XML doc\n\n\n.fsdocs-param-name\na \u0027parameter\u0027 name of an XML doc\n\n\n.fsdocs-returns\nthe \u0027returns\u0027 section of an XML doc\n\n\n.fsdocs-example\nthe \u0027example\u0027 section of an XML doc\n\n\n.fsdocs-note\nthe \u0027notes\u0027 section of an XML doc\n\n\n.fsdocs-para\na paragraph of an XML doc\n\n\n\n\nSome generated elements are given specific HTML ids:\n\n\n\nHTML element selector\nContent\n\n\n\n\nheader\nThe navigation-bar\n\n\n#fsdocs-main-menu\nThe main menu on the left side\n\n\n#content\nThe generated content\n\n\n#fsdocs-page-menu\nThe sub menu on the right side\n\n\ndialog\nThe search dialog\n\n\ndialog input[type=search]\nThe search box\n\n\n#fsdocs-logo\nThe logo\n\n\n\n\nIf you write a new theme by CSS styling please contribute it back to FSharp.Formatting.\nCustomizing via a new template\nYou can do advanced styling by creating a new template. Add a file docs/_template.html, likely starting\nwith the existing default template.\n\nNOTE: To enable hot reload during development with fsdocs watch in a custom _template.html file,\nmake sure to add the single line {{fsdocs-watch-script}} to your \u0026lt;head\u0026gt; tag.\nNOTE: There is no guarantee that your template will continue to work with future versions of F# Formatting.\nIf you do develop a good template please consider contributing it back to F# Formatting.\n\nCustomizing menu items by template\nYou can add advanced styling to the sidebar generated menu items by creating a new template for it.\nfsdoc will look for menu templates in the --input folder, which defaults to the docs folder.\nTo customize the generated menu-item headers, use file _menu_template.html with starting template:\n\u0026lt;li class=\u0022nav-header\u0022\u0026gt;\n {{fsdocs-menu-header-content}}\n\u0026lt;/li\u0026gt;\n{{fsdocs-menu-items}}\n\nSimilarly, to customize the individual menu item list, use file _menu-item_template.html with the starting template:\n\u0026lt;li class=\u0022nav-item\u0022\u0026gt;\u0026lt;a href=\u0022{{fsdocs-menu-item-link}}\u0022 class=\u0022nav-link\u0022\u0026gt;{{fsdocs-menu-item-content}}\u0026lt;/a\u0026gt;\u0026lt;/li\u0026gt;\n\nDo note that files must be added before running, or won\u0027t be generated.\nIn case you want to get a unique identifier for a header or menu item, you can use {{fsdocs-menu-header-id}}\nand {{fsdocs-menu-item-id}}, respectively.\nInjecting additional html into the default template\nOccasionally, you may find the need to make small customizations to the default template, such as adding a Google\nAnalytics snippet or including additional style or script tags. To address this scenario, you can create two\nfiles: _head.html and/or _body.html.\nThe content within these files will serve as replacements for the {{fsdocs-head-extra}} and {{fsdocs-body-extra}}\nplaceholders, which are utilized in the default template.\nCustomizing by generating your own site using your own code\nThe FSharp.Formatting.ApiDocs namespace includes a GenerateModel that captures\nthe results of documentation preparation in ApiDocsModel and allows you to\ngenerate your own site using your own code.\n\nNOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site\ngeneration will continue to work\nwith future versions of F# Formatting.\nNOTE: The ApiDocsModel currently includes some generated HTML with some specific style tags.\nIn the long term these may be removed from the design of that component.\n\n","headings":["Customization and Styling","Customizing via Styling Parameters","Customizing via CSS","CSS variables","CSS classes","Customizing via a new template","Customizing menu items by template","Injecting additional html into the default template","Customizing by generating your own site using your own code"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/literate-notebook.html","title":"Literate Notebooks\n","content":"\nLiterate Notebooks\nContent may be created using .NET interactive 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.\nThe fsdocs tool uses 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.\nF# Formatting tries to faithfully reproduce a notebook\u0027s native appearance when generating documents. Notebook cell outputs are passed through unchanged to preserve the notebook\u0027s html output. The below snippet demonstrates a notebook\u0027s html output for F# records, which differs from the output you would get with the same code inside a literate scripts.\ntype ContactCard =\n { Name: string\n Phone: string\n ZipCode: string }\n\n// Create a new record\n{ Name = \u0026quot;Alf\u0026quot;; Phone = \u0026quot;(555) 555-5555\u0026quot;; ZipCode = \u0026quot;90210\u0026quot; }\n\n{ Name = \u0026quot;Alf\u0026quot;\\n Phone = \u0026quot;(555) 555-5555\u0026quot;\\n ZipCode = \u0026quot;90210\u0026quot; }NameAlfPhone(555) 555-5555ZipCode90210\n.dni-code-hint {\n font-style: italic;\n overflow: hidden;\n white-space: nowrap;\n}\n.dni-treeview {\n white-space: nowrap;\n}\n.dni-treeview td {\n vertical-align: top;\n text-align: start;\n}\ndetails.dni-treeview {\n padding-left: 1em;\n}\ntable td {\n text-align: start;\n}\ntable tr { \n vertical-align: top; \n margin: 0em 0px;\n}\ntable tr td pre \n{ \n vertical-align: top !important; \n margin: 0em 0px !important;\n} \ntable th {\n text-align: start;\n}\n\n\n","headings":["Literate Notebooks"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/literate.html","title":"Literate Scripts\n","content":"\n\u0026emsp;\n\u0026emsp;\n\nLiterate Scripts\nThe following example shows most of the features that can be used in a literate\nF# script file with .fsx extension. Most of the features should be quite self-explanatory:\n(**\n# First-level heading\nSome more documentation using \u0060Markdown\u0060.\n*)\n\nlet helloWorld() = printfn \u0026quot;Hello world!\u0026quot;\n\n(**\n## Second-level heading\nWith some more documentation\n*)\n\nlet numbers = [ 0 .. 99 ]\n(*** include-value: numbers ***)\n\nList.sum numbers\n(*** include-it ***)\n\nThe F# script files are processed as follows:\n\n\nA multi-line comment starting with (** and ending with *) is\nturned into text and is processed using the F# Markdown processor\n(which supports standard Markdown commands).\n\n\nA single-line comment starting with (*** and ending with ***)\nis treated as a special command. The command can consist of\nkey, key: value or key=value pairs.\n\n\n\n\n\nLiterate Command\nDescription\n\n\n\n\n(** ... *)\nMarkdown\n\n\n(*** condition: prepare ***)\nUtilise a code snippet when analyzing for tooltips or executing for outputs\n\n\n(*** condition: ipynb ***)\nInclude a code snippet when making a .ipynb notebook\n\n\n(*** condition: tex ***)\nInclude a code snippet when making a .tex output\n\n\n(*** condition: html ***)\nInclude a code snippet when making HTML output\n\n\n(*** hide ***)\nHide the subsequent snippet\n\n\n(*** raw ***)\nThe subsequent code is treated as raw text\n\n\n\n\nNaming and including snippets\nThe command define defines a named snippet (such as final-sample) and removes the command together with\nthe following F# code block from the main document. The snippet can then\nbe referred to in \u0027include\u0027. This makes it\npossible to write documents without the ordering requirements of the\nF# language.\n\n\n\nLiterate Command\nDescription\n\n\n\n\n(*** define: snippet-name ***)\nDefine a named snippet\n\n\n(*** include: snippet-name ***)\nInclude the code of the named snippet\n\n\n\n\nNaming and including outputs\n\n\n\nLiterate Command\nDescription\n\n\n\n\n(*** define-output: output-name ***)\nDefine a name for the outputs of the preceding snippet\n\n\n(*** include-output ***)\nThe console output of the preceding snippet\n\n\n(*** include-output: output-name ***)\nThe console output of the snippet (named with define-output)\n\n\n(*** include-fsi-output ***)\nThe F# Interactive output of the preceding snippet\n\n\n(*** include-fsi-output: output-name ***)\nThe F# Interactive output of the snippet (named with define-output)\n\n\n(*** include-fsi-merged-output ***)\nThe merge of console output and F# Interactive output of the preceding snippet\n\n\n(*** include-fsi-merged-output: output-name ***)\nThe merge of console output and F# Interactive output of the snippet (named with define-output)\n\n\n(*** include-it ***)\nThe formatted result of the preceding snippet\n\n\n(*** include-it: output-name ***)\nThe formatted result of the snippet (named with define-output)\n\n\n(*** include-it-raw ***)\nThe unformatted result of the preceding snippet\n\n\n(*** include-it-raw: output-name ***)\nThe unformatted result of the snippet (named with define-output)\n\n\n(*** include-value: value-name ***)\nThe formatted value, an F# identifier name\n\n\n\n\nHiding code snippets\nThe command hide specifies that the following F# code block (until the next comment or command) should be\nomitted from the output.\nEvaluating and formatting results\nThe commands to evaluate and format results are explained in evaluation.\nYou must build your documentation with evaluation turned on using --eval.\nSubstitutions\nSubstitutions are applied to content, see content.\nLiterate Markdown Documents\nFor files with .md extension, the entire file is a Markdown document, which may\ncontain F# code snippets (but also other code snippets). As usual, snippets are\nindented with four spaces. In addition, the snippets can be annotated with special\ncommands. Some of them are demonstrated in the following example:\n# First-level heading\n\n [hide]\n let print s = printfn \u0022%s\u0022 s\n\nSome more documentation using \u0060Markdown\u0060.\n\n [module=Hello]\n let helloWorld() = print \u0022Hello world!\u0022\n\n## Second-level heading\nWith some more documentation\n\n [lang=csharp]\n Console.WriteLine(\u0022Hello world!\u0022);\n\nWhen processing the document, all F# snippets are copied to a separate file that\nis type-checked using the F# compiler (to obtain colours and tooltips).\nThe commands are written on the first line of the named snippet, wrapped in [...]:\n\n\nThe hide command specifies that the F# snippet should not be included in the\nfinal document. This can be used to include code that is needed to type-check\nthe code, but is not visible to the reader.\n\n\nThe module=Foo command can be used to specify F# module where the snippet\nis placed. Use this command if you need multiple versions of the same snippet\nor if you need to separate code from different snippets.\n\n\nThe lang=foo command specifies the language of the named snippet. If the language\nis other than fsharp, the snippet is copied to the output as \u0026lt;pre\u0026gt; HTML\ntag without any processing.\n\n\nLaTeX in Literate Scripts and Markdown Documents\nLiterate Scripts may contain LaTeX sections in Markdown using these forms:\n\nSingle line latex starting with $$.\nA block delimited by \\begin{equation}...\\end{equation} or \\begin{align}...\\end{align}.\n\nAn indented paragraph starting with $$$. This is F#-literate-specific and corresponds to\n\\begin{equation}...\\end{equation}.\n\n\nFor example\n$$\\frac{x}{y}$$\n\n\\begin{equation}\n \\frac{d}{dx} \\left. \\left( x \\left( \\left. \\frac{d}{dy} x y \\; \\right|_{y=3} \\right) \\right) \\right|_{x=2}\n\\end{equation}\n\nBecomes\n\\[\\frac{x}{y}\\]\n\\[ \\frac{d}{dx} \\left. \\left( x \\left( \\left. \\frac{d}{dy} x y \\; \\right|_{y=3} \\right) \\right) \\right|_{x=2}\\]\nThe LaTeX will also be used in HTML and iPython notebook outputs.\nMaking literate scripts work for different outputs\nLiterate scripts and markdown can be turned into LaTex, Python Notebooks and F# scripts.\nA header may be needed to get the code to load, a typical example is this:\n (*** condition: prepare ***)\n #nowarn \u0022211\u0022\n #I \u0022../src/FSharp.Formatting/bin/Release/netstandard2.1\u0022\n #r \u0022FSharp.Formatting.Common.dll\u0022\n #r \u0022FSharp.Formatting.Markdown.dll\u0022\n #r \u0022FSharp.Formatting.CodeFormat.dll\u0022\n #r \u0022FSharp.Formatting.Literate.dll\u0022\n (*** condition: fsx ***)\n#if FSX\n #r \u0022nuget: FSharp.Formatting,1.0.0\u0022\n#endif // FSX\n (*** condition: ipynb ***)\n#if IPYNB\n #r \u0022nuget: FSharp.Formatting,1.0.0\u0022\n#endif // IPYNB\n\nProcessing literate files programmatically\nTo process files use the two static methods to turn single documents into HTML\nas follows using functionality from the Literate type:\nopen System.IO\nopen FSharp.Formatting.Literate\n\nlet source = __SOURCE_DIRECTORY__\nlet template = Path.Combine(source, \u0026quot;template.html\u0026quot;)\n\nlet script = Path.Combine(source, \u0026quot;../docs/script.fsx\u0026quot;)\n\nLiterate.ConvertScriptFile(script, template)\n\nlet doc = Path.Combine(source, \u0026quot;../docs/document.md\u0026quot;)\n\nLiterate.ConvertMarkdownFile(doc, template)\n\nThe following sample also uses the optional parameter parameters to specify additional\nkeywords that will be replaced in the template file (this matches the template-project.html\nfile which is included as a sample in the package):\n// Load the template \u0026amp; specify project information\nlet projTemplate = source \u002B \u0026quot;template-project.html\u0026quot;\n\nlet projInfo =\n [ \u0026quot;fsdocs-authors\u0026quot;, \u0026quot;Tomas Petricek\u0026quot;\n \u0026quot;fsdocs-source-link\u0026quot;, \u0026quot;https://github.com/fsprojects/FSharp.Formatting\u0026quot;\n \u0026quot;fsdocs-collection-name\u0026quot;, \u0026quot;F# Formatting\u0026quot; ]\n\nThe methods used above (Literate.ConvertScriptFile, Literate.ConvertMarkdownFile)\nproduce HTML output by default, but they can be also used to produce LaTeX output. This is done\nby setting the output kind. The following\nexample shows how to call the methods to generate LaTeX documents:\nlet templateTex = Path.Combine(source, \u0026quot;template.tex\u0026quot;)\n\nlet scriptTex = Path.Combine(source, \u0026quot;../docs/script.fsx\u0026quot;)\n\nLiterate.ConvertScriptFile(scriptTex, templateTex, outputKind = OutputKind.Latex)\n\nlet docTex = Path.Combine(source, \u0026quot;../docs/document.md\u0026quot;)\n\nLiterate.ConvertMarkdownFile(docTex, templateTex, outputKind = OutputKind.Latex)\n\nThe methods used above (ConvertScriptFile, ConvertMarkdownFile)\ncan also produce iPython Notebook output. This is done\nby setting the named parameter format to OutputKind.Pynb:\n// Process script file, Markdown document and a directory\nlet scriptPynb = Path.Combine(source, \u0026quot;../docs/script.fsx\u0026quot;)\n\nLiterate.ConvertScriptFile(scriptPynb, outputKind = OutputKind.Pynb)\n\nlet docPynb = Path.Combine(source, \u0026quot;../docs/document.md\u0026quot;)\n\nLiterate.ConvertMarkdownFile(docPynb, outputKind = OutputKind.Pynb)\n\nAll of the three methods discussed in the previous two sections take a number of optional\nparameters that can be used to tweak how the formatting works\n","headings":["Literate Scripts","Naming and including snippets","Naming and including outputs","Hiding code snippets","Evaluating and formatting results","Substitutions","Literate Markdown Documents","LaTeX in Literate Scripts and Markdown Documents","Making literate scripts work for different outputs","Processing literate files programmatically"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/users.html","title":"Users of FSharp.Formatting\n","content":"\nUsers of FSharp.Formatting\nThe FSharp.Formatting documentation tool is widely used within the F# community.\nHere is a non-exhaustive list of projects:\n\n\ntable { table-layout: fixed; }\ntr td { padding: 15px 0; }\ntr td p { margin: 0 }\ntr th:first-child, tr td:first-child { width: 20%; }\ntr th:last-child, tr td:last-child { width: 35% }\n\n\n\n\nProject name\n\nRepository\nNote\n\n\n\n\nFSharp.Formatting\n\nhttps://github.com/fsprojects/FSharp.Formatting/\n\n\n\nF# compiler guide\n\nhttps://github.com/dotnet/fsharp/\nThe documentation is generated and published from https://github.com/fsharp/fsharp-compiler-docs\n\n\nF# Core Library Documentation\n\nhttps://github.com/dotnet/fsharp/\nThe documentation is generated and published from https://github.com/fsharp/fsharp-core-docs\n\n\nFsLexYacc\n\nhttps://github.com/fsprojects/fslexYacc/\n\n\n\nFSharp.Data\n\nhttps://github.com/fsprojects/FSharp.Data/\n\n\n\nPlotly.NET\n\nhttps://github.com/plotly/Plotly.NET\n\n\n\nFSharp.Stats\n\nhttps://github.com/fslaborg/FSharp.Stats/\n\n\n\nFsHttp\n\nhttps://github.com/fsprojects/FsHttp/\n\n\n\nFantomas\n\nhttps://github.com/fsprojects/fantomas/\n\n\n\nTelplin\n\nhttps://github.com/nojaf/telplin/\n\n\n\nFSharp.Data.Fred\n\nhttps://github.com/nhirschey/FSharp.Data.Fred/\n\n\n\nN Hirschey Teaching\n\nhttps://github.com/nhirschey/Teaching\n\n\n\nFsUnit\n\nhttps://github.com/fsprojects/FsUnit\n\n\n\nFAKE\n\nhttps://github.com/fsprojects/FAKE\n\n\n\nFSharp.Data.GraphQL\n\nhttps://github.com/fsprojects/FSharp.Data.GraphQL\n\n\n\n\n\n","headings":["Users of FSharp.Formatting"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/content.html","title":"Creating Content\n","content":"\n\u0026emsp;\n\u0026emsp;\n\nCreating Content\nThe \u0022fsdocs\u0022 tool allows documentation for a site to be built\nfrom content in a docs directory. The expected structure for a docs directory is\ndocs/**/*.md -- markdown with embedded code, converted to html and optionally tex/ipynb\ndocs/**/*.fsx -- fsx scripts converted to html and optionally tex/ipynb\ndocs/**/* -- other content, copied over\ndocs/**/_template.html -- optional template, specifies the HTML template for this directory and its contents\ndocs/**/_template.tex -- optionally indicates Latex files should be generated\ndocs/**/_template.ipynb -- optionally indicates F# ipynb files should be generated\ndocs/**/_template.fsx -- optionally indicates F# fsx files should be generated (even from markdown)\ndocs/reference/_template.html -- optionally specifies the default template for reference docs\n\nProcessing is by these two commands:\ndotnet fsdocs build\ndotnet fsdocs watch\n\nThe output goes in output/ by default. Processing is recursive, making this a form of static site generation.\nLiterate Scripts and Markdown Content\nThe input directory may contain literate scripts and markdown content.\nOther Content\nContent that is not *.fsx or *.md is copied across.\nDefault Styling Content\nBy default additional content such as fsdocs-search.js, fsdocs-tips.js and fsdocs-default.css are included in\nthe content directory of the output. This can be suppressed with --nodefaultcontent or by having your own\ncopy of this content in your content directory.\nIgnored Content\nAny file or directory beginning with . is ignored.\nFront matter\nEach content file can have an optional frontmatter. This determines the navigation bar title, categorization ordering and meta tags.\nFor markdown, the format is:\n---\ntitle: Some Title\ncategory: Some Category\ncategoryindex: 2\nindex: 3\ndescription: Some description\nkeywords: tag1, tag2, tag3\n---\n\nFor F# scripts the frontmatter is in this form:\n(**\n---\ntitle: A Literate Script\ncategory: Examples\ncategoryindex: 2\nindex: 1\ndescription: Some description\nkeywords: tag1, tag2, tag3\n---\n*)\n\nAll entries are optional.\nThe categoryindex determines the ordering of categories.\nThe index determines the ordering of within each category.\nThe title is used in the navigation bar instead of any title inferred from the document.\nThe description is used in \u0026lt;meta name=\u0022description\u0022 as part of the {{fsdocs-meta-tags}} substitution.\nThe keywords are also used in a meta tag as part of {{fsdocs-meta-tags}}. Separate them using a ,.\nLink Translation for Inputs\nIf an input is used in markdown as a target of a markdown direct link, then that is replaced by the output file. For example:\n[Some Text](some-file.md)\n\nbecomes\n[Some Text](some-file.html)\n\nif some-file.md is one of the inputs.\nMulti-language Content\nVersions of content in other languages should go in two-letter coded sub-directories, e.g.\ndocs/ja/...\ndocs/de/...\n\nThese will be elided from the main table-of-contents and search indexes. (Currently no language-specific\ntable of contents is built, nor language-specific site search indexes).\nTemplates and Substitutions\nTemplates are used for HTML (_template.html), LaTeX (_template.tex), Notebooks (_template.ipynb)\nand F# script outputs (_template.fsx).\nThe following substitutions determine the primary (non-styling) content of your site.\nFor example {{fsdocs-content}} is replaced with the generated content in each file.\nSubstitutions are applied when generating content from HTML templates, IPYNB templates, FSX templates.\nThey are also applied to content apart from Markdown inline code \u0060...\u0060, Markdown LaTeX and\ngenerated outputs.\nSee Styling for information about template parameters and styling beyond the default template.\n\n\n\nSubstitution name\nGenerated content\n\n\n\n\nroot\n\u0026lt;PackageProjectUrl\u0026gt; else / followed by fsdocs-collection-name\n\n\nfsdocs-collection-name\nName of .sln, single .fsproj or containing directory\n\n\nfsdocs-content\nMain page content\n\n\nfsdocs-list-of-namespaces\nHTML \u0026lt;li\u0026gt; list of namespaces with links\n\n\nfsdocs-list-of-documents\nHTML \u0026lt;li\u0026gt; list of documents with titles and links\n\n\nfsdocs-page-title\nFirst h1 heading in literate file. Generated for API docs\n\n\nfsdocs-source\nOriginal literate script or markdown source\n\n\nfsdocs-source-filename\nName of original input source, relative to the docs root\n\n\nfsdocs-source-basename\nName of original input source, excluding its extensions, relative to the docs root\n\n\nfsdocs-tooltips\nGenerated hidden div elements for tooltips\n\n\nfsdocs-watch-script\nThe websocket script used in watch mode to trigger hot reload\n\n\nfsdocs-previous-page-link\nA relative link to the previous page based on the frontmatter index data\n\n\nfsdocs-next-page-link\nA relative link to the next page based on the frontmatter index data\n\n\nfsdocs-head-extra\nAdditional html content loaded from the _head.html file if present in the --input folder\n\n\nfsdocs-body-extra\nAdditional html content loaded from the _body.html file if present in the --input folder\n\n\nfsdocs-body-class\nA css class value to help distinguish between content and api-docs\n\n\nfsdocs-meta-tags\nA set of additional HTML meta tags, present when description and/or keywords are present in the frontmatter\n\n\n\n\nThe following substitutions are extracted from your project files and may or may not be used by the default\ntemplate:\n\n\n\nSubstitution name\nValue\n\n\n\n\nfsdocs-copyright\n\u0026lt;Copyright\u0026gt;\n\n\nfsdocs-package-project-url\n\u0026lt;PackageProjectUrl\u0026gt;\n\n\nfsdocs-package-license-expression\n\u0026lt;PackageLicenseExpression\u0026gt;\n\n\nfsdocs-package-tags\n\u0026lt;PackageTags\u0026gt;\n\n\nfsdocs-package-version\n\u0026lt;Version\u0026gt;\n\n\n\n\nFor the fsdocs tool, additional substitutions can be specified using --parameters.\nCross References to API Docs\nMarkdown content can contain cross-references to API Docs. Use inline\nmarkdown code snippets of the special form \u0060cref:T:MyNamespace.MyType\u0060 where T:MyNamespace.MyType\nis a method, property or type xml doc sig reference, see API Docs.\nThis can include any cross-references resolved by fsdocs.\nThe generated API documentation includes buttons to copy the XML and Markdown forms of API doc references.\nFor example, within this project,\n\nthe text \u0060cref:T:FSharp.Formatting.Markdown.MarkdownParagraph\u0060 resolves to the link MarkdownParagraph\nthe text \u0060cref:T:System.Console\u0060 resolves to the link Console\nthe text \u0060cref:M:System.Console.WriteLine\u0060 resolves to the link Console.WriteLine\nthe text \u0060cref:M:System.Console.WriteLine(System.String)\u0060 resolves to the link Console.WriteLine\nthe text \u0060\u0060cref:T:FSharp.Control.FSharpAsync\u00601\u0060\u0060 resolves to the link Async\nthe text \u0060cref:T:FSharp.Control.FSharpAsync\u0060 resolves to the link Async\nthe text \u0060\u0060cref:T:FSharp.Core.array\u00601\u0060\u0060 resolves to the link array\nthe text \u0060cref:T:FSharp.Core.OptionModule\u0060 resolves to the link Option\nthe text \u0060\u0060\u0060cref:M:FSharp.Collections.ListModule.Append\u0060\u00601\u0060\u0060\u0060 resolves to the link ListModule.Append\n\n\nNOTE: These cases act as tests - if the links above do not work, then that indicates a bug or a change in the\nexternal link. Please report it.\n\nDetermining xmldoc sig references is not simple. The API doc generated pages come with\nbuttons to copy out the XmlDoc signature.\nGenerating HTML Output\nHTML is generated by default. You can also add a _template.html. This should contain {{fsdocs-content}}, {{fsdocs-tooltips}}\nand other placeholders. Substitutions are\napplied to this template.\nIf a file _template.html exists, then it\u0027s used as the template for HTML generation for that directory and all sub-content.\nGenerating LaTeX output\nTo generate .tex output for each script and markdown file, add a _template.tex. Substitutions are\napplied to this template. The file is either empty or contains {{fsdocs-content}} as the key where the body\nof the document is placed.\nGenerating iPython Notebook output\nTo generate .ipynb output for each script and markdown file, add a _template.ipynb, usually empty. Substitutions are\napplied to this template.\nTo add a mybinder badge to your generated notebook, ensure you have a Dockerfile and NuGet.config\nin your docs directory and use text like this:\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Formatting/gh-pages?filepath=literate.ipynb)\n\nGenerating Script outputs\nTo generate .fsx output for each script and markdown file, add a _template.fsx, usually empty. Substitutions are\napplied to this template. It is either empty or contains {{fsdocs-content}} as the key where the body\nof the script is placed.\n","headings":["Creating Content","Literate Scripts and Markdown Content","Other Content","Default Styling Content","Ignored Content","Front matter","Link Translation for Inputs","Multi-language Content","Templates and Substitutions","Cross References to API Docs","Generating HTML Output","Generating LaTeX output","Generating iPython Notebook output","Generating Script outputs"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/index.html","title":"F# Formatting: Documentation Tools for F# Code\n","content":"F# Formatting: Documentation Tools for F# Code\nFSharp.Formatting is a set of libraries and tools for processing F# script files, markdown and for\ngenerating API documentation. F# Formatting package is used by this project and many other repositories.\nTo use the tool, install and use the fsdocs tool in a typical F# project with\nF# project files plus markdown and script content in the docs directory:\ndotnet tool install fsdocs-tool\ndotnet fsdocs build \ndotnet fsdocs watch\n\nTo use the tool, explore the following topics:\n\nAuthoring Content - explains the content expected in the docs directory for the fsdocs tool.\nUsing the Command line tool - explains how to use the fsdocs tool.\n\nGenerating API documentation - how to generate HTML documentation\nfrom \u0022XML comments\u0022 in your .NET libraries. The tool handles comments written in\nMarkdown too.\n\nStyling - explains some options for styling the output of fsdocs.\n\nUsing literate programming - explains how to generate documentation\nfor your projects or to write nicely formatted F# blog posts.\n\n\nEmbedding F# outputs in literate programming - provides more details on literate programming and\nexplains how to embed results of a literate script file in the generated output. This way,\nyou can easily format the results of running your code!\n\n\nUsing FSharp.Formatting as a library\nF# Formatting is also available on NuGet as a set of libraries.\n\n\nMarkdown parser - explains the F# Markdown\nprocessor that is available in this library with some basic examples of\ndocument processing.\n\n\nF# code formatting - more details about the F# code\nformatter and how to use it to obtain information about F# source files.\n\n\nMore information\nThe documentation for this library is generated automatically using the tools\nbuilt here. If you spot a typo, please submit a pull request! The source Markdown and F# script files are\navailable in the docs folder on GitHub.\nThe project is hosted on GitHub where you can\nreport issues, fork the project and submit pull requests.\nSee the License file in the GitHub repository.\n","headings":["F# Formatting: Documentation Tools for F# Code","Using FSharp.Formatting as a library","More information"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/zero-to-hero.html","title":"Getting Started","content":"\nGetting Started\nFrom zero to hero: deploying to GitHub Pages\nThis guide is meant for a typical setup of open-source projects on GitHub.\nWe start from a repository without any documentation and aim to end up with a published website on GitHub Pages.\nInstall the local tool\nIf you don\u0027t have a dotnet tool manifest, you can create one using dotnet new tool-manifest.\nNext, we can install fsdocs-tool using dotnet tool install --local fsdocs-tool.\nIt is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.\nCreate the docs folder\nAfter we\u0027ve installed the tool, we can run dotnet fsdocs --help and see the available commands.\nBoth build and watch will generate the documentation for a solution and an input folder.\nThe default folder for --input is the ./docs folder, relative to the current working directory.\nTypically, your project will be structured like this:\n/repository-root\n YourSolution.sln\n ./docs\n index.md\n other-file.md\n ./src\n ./Project1/Project1.fsproj\n ./Project2/Project2.fsproj\n\nIt is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.\nWhen users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.\n\u26A0\uFE0F Please avoid putting your solution in the src folder. When we open that solution, it can be more difficult to edit files in the docs folder, as we can sometimes only see the src folder.\nThat being said, let\u0027s create the docs folder and a first Markdown file named index.md.\nWhen fsdocs runs, it will transform this index.md file to index.html, which will be served at the root.\nWe can put # Hello world in the markdown file for now.\nHaving this in place, should already serve the first page when we start the watch command:\n\ndotnet fsdocs watch\n\nOpen http://localhost:8901 and you should see our first page!\n\uD83E\uDE84 You might notice that there are some images missing. You can add these in the docs folder in the right location.\nGenerating API documentation\nBy default, fsdocs will generate API documentation for the configured --projects.\nWhen this flag is not specified, fsdocs will look for solutions or projects in the working directory.\nIt will filter these found projects, the requirements are:\n\nHaving \u0026lt;OutputType\u0026gt;library\u0026lt;/OutputType\u0026gt;\nHaving a binary, so you need to build your project first before the documentation can be generated.\nNot having \u0026lt;IsTestProject\u0026gt;true\u0026lt;/IsTestProject\u0026gt;\nHaving \u0026lt;GenerateDocumentationFile\u0026gt;true\u0026lt;/GenerateDocumentationFile\u0026gt;\n\n\uD83E\uDE84 If you made some changes in order to adhere to the rules, you may want to remove the .fsdocs/cache file.\nAdding the missing properties\nAfter our initial watch run, you may have noticed that some links aren\u0027t working yet.\nLicense, Releases Notes and Source Repository can be provided by setting MSBuild properties.\nYou can either add these properties to a single .fsproj file, or more typically, add them to a Directory.Build.props file.\nThe simplest Directory.Build.props file:\n\u0026lt;Project\u0026gt;\n \u0026lt;PropertyGroup\u0026gt;\n \u0026lt;RepositoryUrl\u0026gt;https://github.com/fsprojects/FSharp.AWS.DynamoDB\u0026lt;/RepositoryUrl\u0026gt;\n \u0026lt;FsDocsLicenseLink\u0026gt;https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md\u0026lt;/FsDocsLicenseLink\u0026gt;\n \u0026lt;FsDocsReleaseNotesLink\u0026gt;https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md\u0026lt;/FsDocsReleaseNotesLink\u0026gt;\n \u0026lt;PackageProjectUrl\u0026gt;https://fsprojects.github.io/FSharp.AWS.DynamoDB\u0026lt;/PackageProjectUrl\u0026gt;\n \u0026lt;/PropertyGroup\u0026gt;\n\u0026lt;/Project\u0026gt;\n\n\uD83E\uDE84 If you don\u0027t have any release notes yet, you could consider using Ionide.KeepAChangelog.\nRunning dotnet fsdocs watch will now yield:\n root --\u0026gt; https://github.com/fsprojects/FSharp.AWS.DynamoDB/\n ...\n fsdocs-license-link --\u0026gt; https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md\n fsdocs-release-notes-link --\u0026gt; https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md\n ...\n fsdocs-repository-link --\u0026gt; https://github.com/fsprojects/FSharp.AWS.DynamoDB/\n\n\u26A0\uFE0F Again, you might need to remove .fsdocs/cache in order for changes to be picked up!\n\u0026lt;PackageProjectUrl\u0026gt; is actually a very important property when you run dotnet fsdocs build.\nbuild will generate static files for the targeted production environment. In our case, this will be GitHub Pages.\nPages will host your files from https://github.com/user/project on https://user.github.io/project/ by default.\nYou can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.\nLet\u0027s now run dotnet fsdocs build.\n\u0026lt;PackageProjectUrl\u0026gt; will replace the {{root}} substitution, which is used all over the place in the default template.\n\u26A0\uFE0F You want to ensure that the static files in the output folder (after running the build) have the correct links.\nIgnore generated files\nAlright, at this point we\u0027ve made a lot of progress. If you are using git you want to add the following to your .gitignore file.\n# FSharp.Formatting\n.fsdocs/\noutput/\ntmp/\n\nShip it!\nOnce we are satisfied with our documentation, we want to publish it to GitHub Pages.\nWe can use GitHub Actions to deploy our website.\nDeploy to Pages from GitHub Actions must be enabled in the repository settings:\n\nThe typical flow is to publish your documentation after a release or after new commits were added to the default branch.\nLet\u0027s create a very basic Action that will deploy our website after pushing to the main:\nCreate a file .github/workflows/docs.yml:\nname: Docs\n\n# Trigger this Action when new code is pushed to the main branch\non:\n push:\n branches:\n - main\n\n# We need some permissions to publish to Github Pages\npermissions:\n contents: write\n pages: write\n id-token: write\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n # Checkout the source code\n - uses: actions/checkout@v4\n # Setup dotnet, please use a global.json to ensure the right SDK is used!\n - name: Setup .NET\n uses: actions/setup-dotnet@v3\n # Restore the local tools\n - name: Restore tools\n run: dotnet tool restore\n # Build the code for the API documentation\n - name: Build code\n run: dotnet build -c Release YourSolution.sln\n # Generate the documentation files\n - name: Generate the documentation\u0027\n run: dotnet fsdocs build --properties Configuration=Release\n # Upload the static files\n - name: Upload documentation\n uses: actions/upload-pages-artifact@v2\n with:\n path: ./output\n \n # GitHub Actions recommends deploying in a separate job.\n deploy:\n runs-on: ubuntu-latest\n needs: build\n steps:\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v2\n\n\u26A0\uFE0F Careful yaml is indentation sensitive!\nNext steps\nMission accomplished, right? If everything went well, you should have a published website at this point!\nHere are some next steps you could consider:\nUse fsx file in your documentation\nCreate documentation using Literate Scripts. A typical flow here is that you load your locate project binary into a script and create examples using the latest code:\n#r \u0026quot;../src/Project1/bin/Debug/net6.0/Project1.dll\u0026quot;\n\nopen Project1\n\n// Actual consumption of your project!\nlet result = SomeType.SomeMethod(\u0026quot;foo\u0026quot;)\n\nWhen using the --strict flag in dotnet fsdocs build, your documentation generation will fail if your script contains errors.\nThis is useful to ensure your documentation is always in sync with your latest public API!\nAutomatically update to newer versions of fsdocs-tool\nUsing Dependabot you can easily receive new PR\u0027s with updates to your dotnet dependencies.\nCreate a .github/dependabot.yml file with:\nversion: 2\nupdates:\n # Update to newer version of GitHub Actions\n - package-ecosystem: \u0022github-actions\u0022\n directory: \u0022/\u0022\n schedule:\n interval: \u0022weekly\u0022\n\n # Update to newer NuGet dependencies\n - package-ecosystem: \u0022nuget\u0022\n directory: \u0022/\u0022\n schedule:\n interval: \u0022daily\u0022\n\nThis will automatically create a new PR when there is an update to the fsdocs tool.\n\u26A0\uFE0F P\uFE0Flease be very careful, if you have followed along, we don\u0027t have any GitHub Actions right now that run against pull requests!\nIt is recommended to have an Action that builds your documentation against any incoming changes.\nYou typically want to lint code, run unit tests and perform other useful checks as well!\nExample Action, .github/workflows/ci.yml:\nname: CI\n\non: [pull_request]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v3\n - name: Setup .NET Core\n uses: actions/setup-dotnet@v3\n - name: Restore tools\n run: dotnet tool restore\n - name: Build\n run: dotnet build YourSolution.sln\n - name: Documentation\n run: dotnet fsdocs build\n\n\u26A0\uFE0F Also, never trust any update to fsdocs blindly, always check the release notes to see if there are any breaking changes.\n","headings":["Getting Started","From zero to hero: deploying to GitHub Pages","Install the local tool","Create the docs folder","Generating API documentation","Adding the missing properties","Ignore generated files","Ship it!","Next steps","Use fsx file in your documentation","Automatically update to newer versions of fsdocs-tool"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/upgrade.html","title":"Upgrading to fsdocs\n","content":"\nUpgrading to fsdocs\nHere are the typical steps to upgrade a repo based on ProjectScaffold to use fsdocs\n\n\nRun\ndotnet new tool\ndotnet tool install fsdocs-tool\n\n\nDelete all of docs\\tools particularly docs\\tool\\generate.fsx. Keep a copy of any templates for reference as you\u0027ll have to copy some bits across to the new template.\nPut your docs directory so it reflects the final shape of the site. For example move the content of docs\\input\\* and docs\\files\\* directly to docs\\*\nFollow the notes in styling to start to style your site.\n\nRun\ndotnet fsdocs watch\n\nand edit and test your docs.\n\n\nIf using FAKE adjust build.fsx e.g.\nTarget.create \u0022GenerateDocs\u0022 (fun _ -\u0026gt;\n Shell.cleanDir \u0022.fsdocs\u0022\n DotNet.exec id \u0022fsdocs\u0022 \u0022build --clean\u0022 |\u0026gt; ignore\n)\n\nTarget.create \u0022ReleaseDocs\u0022 (fun _ -\u0026gt;\n Git.Repository.clone \u0022\u0022 projectRepo \u0022temp/gh-pages\u0022\n Git.Branches.checkoutBranch \u0022temp/gh-pages\u0022 \u0022gh-pages\u0022\n Shell.copyRecursive \u0022output\u0022 \u0022temp/gh-pages\u0022 true |\u0026gt; printfn \u0022%A\u0022\n Git.CommandHelper.runSimpleGitCommand \u0022temp/gh-pages\u0022 \u0022add .\u0022 |\u0026gt; printfn \u0022%s\u0022\n let cmd = sprintf \u0022\u0022\u0022commit -a -m \u0022Update generated documentation for version %s\u0022\u0022\u0022 release.NugetVersion\n Git.CommandHelper.runSimpleGitCommand \u0022temp/gh-pages\u0022 cmd |\u0026gt; printfn \u0022%s\u0022\n Git.Branches.push \u0022temp/gh-pages\u0022\n)\n\n\n\nConsider creating docs\\_template.fsx and docs\\_template.ipynb to enable co-generation of F# scripts and F# notebooks.\nIf you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example like this.\nAlso add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo. For example like this.\n\n\nSample commands:\ndotnet tool install fsdocs-tool --local\ngit add dotnet-tools.json \ngit rm -fr docs/tools\ngit mv docs/input/* docs\ngit mv docs/files/* docs\n\n\u0026lt;manually download and fixup the _template.html\u0026gt;\n\ndotnet fsdocs watch\n\ntouch docs/_template.fsx\ntouch docs/_template.ipynb\ngit add docs/_template.fsx\ngit add docs/_template.ipynb\n\nHere is an example PR: https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116\n","headings":["Upgrading to fsdocs"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/markdown.html","title":"Markdown parser\n","content":"\n\u0026emsp;\n\u0026emsp;\n\nMarkdown parser\nThis page demonstrates how to use FSharp.Formatting.Markdown to parse a Markdown\ndocument, process the obtained document representation, and\nhow to turn the code into a nicely formatted HTML.\nFirst, we need to load the assembly and open the necessary namespaces:\nopen FSharp.Formatting.Markdown\nopen FSharp.Formatting.Common\n\nParsing documents\nThe F# Markdown parser recognizes the standard Markdown syntax\nand it is not the aim of this tutorial to fully document it.\nThe following snippet creates a simple string containing a document\nwith several elements and then parses it using the Markdown.Parse method:\nlet document =\n \u0026quot;\u0026quot;\u0026quot;\n# F# Hello world\nHello world in [F#](http://fsharp.net) looks like this:\n\n printfn \u0026quot;Hello world!\u0026quot;\n\nFor more see [fsharp.org][fsorg].\n\n [fsorg]: http://fsharp.org \u0026quot;The F# organization.\u0026quot; \u0026quot;\u0026quot;\u0026quot;\n\nlet parsed = Markdown.Parse(document)\n\nThe sample document consists of a first-level heading (written using\none of the two alternative styles) followed by a paragraph with a\ndirect link, code snippet and one more paragraph that includes an\nindirect link. The URLs of indirect links are defined by a separate\nblock as demonstrated on the last line (and they can then be easily used repeatedly\nfrom multiple places in the document).\nWorking with parsed documents\nThe F# Markdown processor does not turn the document directly into HTML.\nInstead, it builds a nice F# data structure that we can use to analyze,\ntransform and process the document. First of all the MarkdownDocument.DefinedLinks property\nreturns all indirect link definitions:\nparsed.DefinedLinks\nval it : IDictionary\u0026lt;string,(string * string option)\u0026gt; =\n dict [(\u0026quot;fsorg\u0026quot;, (\u0026quot;http://fsharp.org\u0026quot;, Some \u0026quot;The F# organization.\u0026quot;))]\n\nThe document content can be accessed using the MarkdownDocument.Paragraphs property that returns\na sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).\nThe following snippet prints the heading of the document:\n// Iterate over all the paragraph elements\nfor par in parsed.Paragraphs do\n match par with\n | Heading (size = 1; body = [ Literal (text = text) ]) -\u0026gt;\n // Recognize heading that has a simple content\n // containing just a literal (no other formatting)\n printfn \u0026quot;%s\u0026quot; text\n | _ -\u0026gt; ()\n\nYou can find more detailed information about the document structure and how to process it\nin the book F# Deep Dives.\nProcessing the document recursively\nThe library provides active patterns that can be used to easily process the Markdown\ndocument recursively. The example in this section shows how to extract all links from the\ndocument. To do that, we need to write two recursive functions. One that will process\nall paragraph-style elements and one that will process all inline formattings (inside\nparagraphs, headings etc.).\nTo avoid pattern matching on every single kind of span and every single kind of\nparagraph, we can use active patterns from the MarkdownPatterns module. These can be use\nto recognize any paragraph or span that can contain child elements:\n/// Returns all links in a specified span node\nlet rec collectSpanLinks span =\n seq {\n match span with\n | DirectLink (link = url) -\u0026gt; yield url\n | IndirectLink (key = key) -\u0026gt; yield fst (parsed.DefinedLinks.[key])\n | MarkdownPatterns.SpanLeaf _ -\u0026gt; ()\n | MarkdownPatterns.SpanNode (_, spans) -\u0026gt;\n for s in spans do\n yield! collectSpanLinks s\n }\n\n/// Returns all links in the specified paragraph node\nlet rec collectParLinks par =\n seq {\n match par with\n | MarkdownPatterns.ParagraphLeaf _ -\u0026gt; ()\n | MarkdownPatterns.ParagraphNested (_, pars) -\u0026gt;\n for ps in pars do\n for p in ps do\n yield! collectParLinks p\n | MarkdownPatterns.ParagraphSpans (_, spans) -\u0026gt;\n for s in spans do\n yield! collectSpanLinks s\n }\n\n// Collect links in the entire document\nSeq.collect collectParLinks parsed.Paragraphs\nval it : seq\u0026lt;string\u0026gt; =\n seq [\u0026quot;http://fsharp.net\u0026quot;; \u0026quot;http://fsharp.org\u0026quot;]\n\nThe collectSpanLinks function works on individual span elements that contain inline\nformatting (emphasis, strong) and also links. The DirectLink node from MarkdownSpan represents an inline\nlink like the one pointing to http://fsharp.net while IndirectLink represents a\nlink that uses one of the link definitions. The function simply returns the URL associated\nwith the link.\nSome span nodes (like emphasis) can contain other formatting, so we need to recursively\nprocess children. This is done by matching against MarkdownPatterns.SpanNodes which is an active\npattern that recognizes any node with children. The library also provides a function\nnamed MarkdownPatterns.SpanNode that can be used to reconstruct the same node (when you want\nto transform a document). This is similar to how the ExprShape module for working with\nF# quotations works.\nThe function collectParLinks processes paragraphs - a paragraph cannot directly be a\nlink so we just need to process all spans. This time, there are three options.\nParagraphLeaf represents a case where the paragraph does not contain any spans\n(a code block or, for example, a \u0026lt;hr\u0026gt; line); the ParagraphNested case is used for paragraphs\nthat contain other paragraphs (quotation) and ParagraphSpans is used for all other\nparagraphs that contain normal text - here we call collectSpanLinks on all nested spans.\nGenerating HTML output\nFinally, the Markdown type also includes a method Markdown.ToHtml that can be used\nto generate an HTML document from the Markdown input. The following example shows how to call it:\nlet html = Markdown.ToHtml(parsed)\n\nThere are also methods to generate .fsx, .ipynb, .md and .tex.\n","headings":["Markdown parser","Parsing documents","Working with parsed documents","Processing the document recursively","Generating HTML output"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/codeformat.html","title":"Code formatting\n","content":"\n\u0026emsp;\n\u0026emsp;\n\nCode formatting\nThis page demonstrates how to use FSharp.Formatting.CodeFormat to tokenize\nF# source code, obtain information about the source code (mainly tooltips\nfrom the type-checker) and how to turn the code into a nicely formatted HTML.\nFirst, we need to load the assembly and open the necessary namespaces:\nopen FSharp.Formatting.CodeFormat\nopen System.Reflection\n\nIf you want to process multiple snippets, it is a good idea to keep the\nformatting agent around if possible. The agent needs to load the F# compiler\n(which needs to load various files itself) and so this takes a long time.\nProcessing F# source\nThe formatting agent provides a CodeFormatAgent.ParseAndCheckSource method (together with an asynchronous\nversion for use from F# and also a version that returns a .NET Task for C#).\nTo call the method, we define a simple F# code as a string:\nlet source =\n \u0026quot;\u0026quot;\u0026quot;\n let hello () =\n printfn \u0026quot;Hello world\u0026quot;\n \u0026quot;\u0026quot;\u0026quot;\n\nlet snippets, diagnostics =\n CodeFormatter.ParseAndCheckSource(\u0026quot;C:\\\\snippet.fsx\u0026quot;, source, None, None, ignore)\n\nWhen calling the method, you need to specify a file name and the actual content\nof the script file. The file does not have to physically exist. It is used by the\nF# compiler to resolve relative references (e.g. #r) and to automatically name\nthe module including all code in the file.\nYou can also specify additional parameters, such as *.dll references, by passing\na third argument with compiler options (e.g. \u0022-r:Foo.dll -r:Bar.dll\u0022).\nThis operation might take some time, so it is a good idea to use an asynchronous\nvariant of the method. It returns two arrays - the first contains F# snippets\nin the source code and the second contains any errors reported by the compiler.\nA single source file can include multiple snippets using the same formatting tags\nas those used on fssnip.net as documented in the\nabout page.\nWorking with returned tokens\nEach returned snippet is essentially just a collection of lines, and each line\nconsists of a sequence of tokens. The following snippet prints basic information\nabout the tokens of our sample snippet:\n// Get the first snippet and obtain list of lines\nlet (Snippet (title, lines)) = snippets |\u0026gt; Seq.head\n\n// Iterate over all lines and all tokens on each line\nfor (Line (_, tokens)) in lines do\n for token in tokens do\n match token with\n | TokenSpan.Token (kind, code, tip) -\u0026gt;\n printf \u0026quot;%s\u0026quot; code\n\n tip\n |\u0026gt; Option.iter (fun spans -\u0026gt; printfn \u0026quot;%A\u0026quot; spans)\n | TokenSpan.Omitted _\n | TokenSpan.Output _\n | TokenSpan.Error _ -\u0026gt; ()\n\n printfn \u0026quot;\u0026quot;\n\nThe TokenSpan.Token is the most important kind of token. It consists of a kind\n(identifier, keyword, etc.), the original F# code and tooltip information.\nThe tooltip is further formatted using a simple document format, but we simply\nprint the value using the F# pretty printing, so the result looks as follows:\nlet hello[Literal \u0026quot;val hello : unit -\u0026gt; unit\u0026quot;; ...] () =\n printfn[Literal \u0026quot;val printfn : TextWriterFormat\u0026lt;\u0026#39;T\u0026gt; -\u0026gt; \u0026#39;T\u0026quot;; ...] \u0026quot;Hello world\u0026quot;\n\nThe Omitted token is generated if you use the special (*[omit:...]*) command.\nThe Output token is generated if you use the // [fsi:...] command to format\noutput returned by F# interactive. The Error command wraps code that should be\nunderlined with a red squiggle if the code contains an error.\nGenerating HTML output\nFinally, the CodeFormat type also includes a method CodeFormat.FormatHtml that can be used\nto generate nice HTML output from an F# snippet. This is used, for example, on\nF# Snippets. The following example shows how to call it:\nlet prefix = \u0026quot;fst\u0026quot;\nlet html = CodeFormat.FormatHtml(snippets, prefix)\n\n// Print all snippets, in case there is more of them\nfor snip in html.Snippets do\n printfn \u0026quot;%s\u0026quot; snip.Content\n\n// Print HTML code that is generated for ToolTips\nprintfn \u0026quot;%s\u0026quot; html.ToolTip\n\nIf the input contains multiple snippets separated using the //[snippet:...] comment, e.g.:\n\n1: \n2: \n3: \n4: \n5: \n6: \n7: \n\n\n// [snippet: First sample]\nprintf \u0022The answer is: %A\u0022 42\n// [/snippet]\n// [snippet: Second sample]\nprintf \u0022Hello world!\u0022\n// [/snippet]\n\n\n\n\nthen the formatter returns multiple HTML blocks. However, the generated tooltips\nare shared by all snippets (to save space) and so they are returned separately.\n","headings":["Code formatting","Processing F# source","Working with returned tokens","Generating HTML output"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/commandline.html","title":"Command line\n","content":"\nCommand line\nTo use F# Formatting tools via the command line, you can use the fsdocs dotnet tool.\ndotnet tool install fsdocs-tool\ndotnet fsdocs [command] [options]\n\nThe build command\nThis command processes a docs directory and generates API docs for projects in the solution according to the\nrules of API doc generation. The input accepted is described in content.\nfsdocs build\n\nThe command line options accepted are:\n\n\n\nCommand Line Option\nDescription\n\n\n\n\n--input\nInput directory of content (default: docs)\n\n\n--projects\nProject files to build API docs for outputs, defaults to all packable projects\n\n\n--output\nOutput Directory (default \u0027output\u0027 for \u0027build\u0027 and \u0027tmp/watch\u0027 for \u0027watch\u0027)\n\n\n--noapidocs\nDisable generation of API docs\n\n\n--ignoreprojects\nDisable project cracking\n\n\n--eval\nEvaluate F# fragments in scripts\n\n\n--saveimages\nSave images referenced in docs\n\n\n--nolinenumbers\nDon\u0027t add line numbers, the default is to add line numbers.\n\n\n--parameters\nAdditional substitution parameters for templates\n\n\n--nonpublic\nThe tool will also generate documentation for non-public members\n\n\n--nodefaultcontent\nDo not copy default content styles, javascript or use default templates\n\n\n--clean\nClean the output directory\n\n\n--help\nDisplay this help screen\n\n\n--version\nDisplay version information\n\n\n--properties\nProvide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4\n\n\n--fscoptions\nAdditional arguments passed down as otherflags to the F# compiler when the API is being generated.Note that these arguments are trimmed, this is to overcome a limitation in the command line argument processing.A typical use-case would be to pass an addition assembly reference.Example --fscoptions \u0022 -r:MyAssembly.dll\u0022\n\n\n--strict\nFail if docs are missing or can\u0027t be generated\n\n\n\n\nThe following command line options are also accepted but it is instead recommended you use\nsettings in your .fsproj project files:\n\n\n\nCommand Line Option\nDescription\n\n\n\n\n--sourcefolder\nSource folder at time of component build (\u0026lt;FsDocsSourceFolder\u0026gt;)\n\n\n--sourcerepo\nSource repository for github links (\u0026lt;FsDocsSourceRepository\u0026gt;)\n\n\n--mdcomments\nAssume comments in F# code are markdown (\u0026lt;UsesMarkdownComments\u0026gt;)\n\n\n\n\nThe command will report on any .fsproj files that it finds, telling you if it decides to skip a particular file and why.\nFor example, a project will be skipped if:\n\nThe project name contains \u0022.Tests\u0022 or \u0022test\u0022 (because it looks like a test project)\n\nThe project does not contain\n\u0026lt;GenerateDocumentationFile\u0026gt;true\u0026lt;/GenerateDocumentationFile\u0026gt;\n\n\n\nThe watch command\nThis command does the same as fsdocs build but in \u0022watch\u0022 mode, waiting for changes. Only the files in the input\ndirectory (e.g. docs) are watched. A browser will be launched automatically (unless --nolaunch is specified).\nYou will need to ensure that the input directory exists, and contains at least index.md, otherwise the browser will\nreport an error (e.g. \u0022Problem loading...\u0022, \u0022Connection was reset\u0022).\nfsdocs watch\n\nRestarting may be necesssary on changes to project files. The same parameters are accepted, plus these:\n\n\n\nCommand Line Option\nDescription\n\n\n\n\n--noserver\nDo not serve content when watching.\n\n\n--nolaunch\nDo not launch a browser window.\n\n\n--open\nURL extension to launch http://localhost:/%s.\n\n\n--port\nPort to serve content for http://localhost serving.\n\n\n\n\nSearchable docs\nWhen using the command-line tool a Fuse search index is automatically generated in index.json.\nA search box is included in the default template via an HTML Dialog element.\nTo add search to your own _template.html:\n\ninclude an HTML element with id search-btn\ninclude a dialog element\ninclude fsdocs-search.js script\n\n\u0026lt;button id=\u0022search-btn\u0022\u0026gt;Open search dialog\u0026lt;/button\u0026gt;\n\u0026lt;dialog\u0026gt;\n \u0026lt;input type=\u0022search\u0022 placeholder=\u0022Search docs\u0022 /\u0026gt;\n \u0026lt;div class=\u0022results\u0022\u0026gt;\n \u0026lt;ul\u0026gt;\u0026lt;/ul\u0026gt;\n \u0026lt;p class=\u0022empty\u0022\u0026gt;Type something to start searching.\u0026lt;/p\u0026gt;\n \u0026lt;/div\u0026gt;\n\u0026lt;/dialog\u0026gt;\n\u0026lt;script type=\u0022module\u0022 src=\u0022{\u0060{root}}content/fsdocs-search.js\u0022\u0026gt;\u0026lt;/script\u0026gt;\n\n","headings":["Command line","The build command","The watch command","Searchable docs"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/sidebyside/sidemarkdown.html","title":"Markdown Content","content":"\nExample: Using Markdown Content\nThis file demonstrates how to write Markdown document with\nembedded F# snippets that can be transformed into nice HTML\nusing the literate.fsx script from the F# Formatting\npackage.\nIn this case, the document itself is a valid Markdown and\nyou can use standard Markdown features to format the text:\n\nHere is an example of an unordered list and...\nText formatting including bold and emphasis\n\nFor more information, see the Markdown reference.\nWriting F# code\nIn standard Markdown, you can include code snippets by\nwriting a block indented by four spaces and the code\nsnippet will be turned into a \u0026lt;pre\u0026gt; element. If you do\nthe same using the Literate F# tool, the code is turned into\na nicely formatted F# snippet:\n/// The Hello World of functional languages!\nlet rec factorial x = \n if x = 0 then 1 \n else x * (factorial (x - 1))\n\nlet f10 = factorial 10\n\nHiding code\nIf you want to include some code in the source code,\nbut omit it from the output, you can use the hide\ncommand. You can also use module=... to specify that\nthe snippet should be placed in a separate module\n(e.g. to avoid duplicate definitions).\nThe value will be defined in the F# code that is\nprocessed and so you can use it from other (visible)\ncode and get correct tooltips:\nlet answer = Hidden.answer\n\nIncluding other snippets\nWhen writing literate programs as Markdown documents,\nyou can also include snippets in other languages.\nThese will not be colorized and processed as F#\ncode samples:\nConsole.WriteLine(\u0022Hello world!\u0022);\n\nThis snippet is turned into a pre element with the\nlang attribute set to csharp.\n","headings":["Example: Using Markdown Content","Writing F# code","Hiding code","Including other snippets"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/sidebyside/sideextensions.html","title":"Markdown LaTeX","content":"\nExample: Using the Markdown Extensions for LaTeX\n\nTo use LaTex extension, you need to add javascript\nlink to MathJax in\nyour template or inside a _head.html file.\n\u0026lt;script id=\u0022MathJax-script\u0022 async src=\u0022https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js\u0022\u0026gt;\u0026lt;/script\u0026gt;\n\nTo use inline LaTex, eclose LaTex code with $:\n\\(k_{n\u002B1} = n^2 \u002B k_n^2 - k_{n-1}\\). Alternatively,\nyou can also use $$.\nTo use block LaTex, start a new paragraph, with\nthe first line marked as $$$ (no close $$$):\n\\[A_{m,n} =\n \\begin{pmatrix}\n a_{1,1} \u0026amp; a_{1,2} \u0026amp; \\cdots \u0026amp; a_{1,n} \\\\\n a_{2,1} \u0026amp; a_{2,2} \u0026amp; \\cdots \u0026amp; a_{2,n} \\\\\n \\vdots \u0026amp; \\vdots \u0026amp; \\ddots \u0026amp; \\vdots \\\\\n a_{m,1} \u0026amp; a_{m,2} \u0026amp; \\cdots \u0026amp; a_{m,n}\n \\end{pmatrix}\\]\nUse LaTex escape rule:\n\nEscape $ in inline mode: \\(\\$\\), \\(\\$var\\)\nOther escapes: \\(\\\u0026amp; \\% \\$ \\# \\_ \\{ \\}\\)\n\nUsing : \\(x \u0026gt; 1\\), \\(y \u0026lt; 1\\), \\(x \u0026gt;= 1\\),\n\\(y \u0026lt;= 1\\), \\(x = 1\\)\n\n\\(\u0026lt;p\u0026gt;something\u0026lt;/p\u0026gt;\\)\n\n","headings":["Example: Using the Markdown Extensions for LaTeX"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/sidebyside/sidescript.html","title":"Literate Script","content":"\nExample: Using Literate Script Content\nThis file demonstrates how to write literate F# script\nfiles (*.fsx) that can be transformed into nice HTML\nusing the literate.fsx script from the F# Formatting\npackage.\nAs you can see, a comment starting with a double asterisk\nis treated as part of the document and is transformed\nusing Markdown, which means that you can use:\n\nUnordered or ordered lists\nText formatting including bold and emphasis\n\nAnd numerous other Markdown features.\nWriting F# code\nCode that is not inside the comment will be formatted as\na sample snippet.\n/// The Hello World of functional languages!\nlet rec factorial x =\n if x = 0 then 1 else x * (factorial (x - 1))\n\nlet f10 = factorial 10\n\nHiding code\nIf you want to include some code in the source code,\nbut omit it from the output, you can use the hide\ncommand.\nThe value will be defined in the F# code and so you\ncan use it from other (visible) code and get the correct\ntooltips:\nlet answer = hidden\n\nMoving code around\nSometimes, it is useful to first explain some code that\nhas to be located at the end of the snippet (perhaps\nbecause it uses some definitions discussed in the middle).\nThis can be done using include and define commands.\nThe following snippet gets the correct tooltips, even though\nit uses laterFunction:\nlet sample = laterFunction () |\u0026gt; printfn \u0026quot;Got: %s\u0026quot;\n\nThen, we can explain how laterFunction is defined:\nlet laterFunction () = \u0026quot;Not very difficult, is it?\u0026quot;\n\nThis example covers pretty much all features that are\ncurrently implemented in literate.fsx, but feel free\nto fork the project on GitHub and add more\nfeatures or report bugs!\n","headings":["Example: Using Literate Script Content","Writing F# code","Hiding code","Moving code around"],"type":"content"},{"uri":"https://fsprojects.github.io/FSharp.Formatting/templates/leftside/styling.html","title":"Example: Styling for Right-Side Navigation Bar\n","content":"\nExample: Styling for Right-Side Navigation Bar\n\n:root {\n --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);\n --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);\n --main-menu-grid-column: 2;\n --main-grid-column: 1;\n}\n\nThe sidebar can be moved to the right by overwriting the following CSS variables in your fsdocs-theme.css file:\n:root {\n --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);\n --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);\n --main-menu-grid-column: 2;\n --main-grid-column: 1;\n}\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\nSed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?\n","headings":["Example: Styling for Right-Side Navigation Bar"],"type":"content"}] \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 000000000..8cebe56c0 --- /dev/null +++ b/index.md @@ -0,0 +1,61 @@ +# F# Formatting: Documentation Tools for F# Code + +FSharp.Formatting is a set of libraries and tools for processing F# script files, markdown and for +generating API documentation. F# Formatting package is used by this project and many other repositories. + +To use the tool, install and use the [fsdocs](commandline.html) tool in a typical F# project with +F# project files plus markdown and script content in the `docs` directory: + + dotnet tool install fsdocs-tool + dotnet fsdocs build + dotnet fsdocs watch + +To use the tool, explore the following topics: + +* [Authoring Content](content.html) - explains the content expected in the `docs` directory for the `fsdocs` tool. + + +* [Using the Command line tool](commandline.html) - explains how to use the `fsdocs` tool. + + +* [Generating API documentation](apidocs.html) - how to generate HTML documentation +from "XML comments" in your .NET libraries. The tool handles comments written in +Markdown too. + + +* [Styling](styling.html) - explains some options for styling the output of `fsdocs`. + + +* [Using literate programming](literate.html) - explains how to generate documentation +for your projects or to write nicely formatted F# blog posts. + + +* [Embedding F# outputs in literate programming](evaluation.html) - provides more details on literate programming and +explains how to embed results of a literate script file in the generated output. This way, +you can easily format the results of running your code! + + +## Using FSharp.Formatting as a library + +F# Formatting is also [available on NuGet](https://nuget.org/packages/FSharp.Formatting) as a set of libraries. + +* [Markdown parser](markdown.html) - explains the F# Markdown +processor that is available in this library with some basic examples of +document processing. + + +* [F# code formatting](codeformat.html) - more details about the F# code +formatter and how to use it to obtain information about F# source files. + + +## More information + +The documentation for this library is generated automatically using the tools +built here. If you spot a typo, please submit a pull request! The source Markdown and F# script files are +available in the [docs folder on GitHub](https://github.com/fsprojects/FSharp.Formatting/tree/master/docs). + +The project is hosted on [GitHub](https://github.com/fsprojects/FSharp.Formatting) where you can +[report issues](https://github.com/fsprojects/FSharp.Formatting/issues), fork the project and submit pull requests. +See the [License file](https://github.com/fsprojects/FSharp.Formatting/blob/master/LICENSE.md) in the GitHub repository. + + diff --git a/index.tex b/index.tex new file mode 100644 index 000000000..834aa4923 --- /dev/null +++ b/index.tex @@ -0,0 +1,134 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + +\section*{F\# Formatting: Documentation Tools for F\# Code} + + + +FSharp.Formatting is a set of libraries and tools for processing F\# script files, markdown and for +generating API documentation. F\# Formatting package is used by this project and many other repositories. + + +To use the tool, install and use the \href{commandline.html}{fsdocs} tool in a typical F\# project with +F\# project files plus markdown and script content in the \texttt{docs} directory: +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\id{dotnet} \id{tool} \id{install} \id{fsdocs}\ops{-}\id{tool} +\id{dotnet} \id{fsdocs} \id{build} +\id{dotnet} \id{fsdocs} \id{watch} + + +\end{lstlisting} + + + +To use the tool, explore the following topics: +\begin{itemize} +\item + +\href{content.html}{Authoring Content} - explains the content expected in the \texttt{docs} directory for the \texttt{fsdocs} tool. + +\item + +\href{commandline.html}{Using the Command line tool} - explains how to use the \texttt{fsdocs} tool. + +\item + +\href{apidocs.html}{Generating API documentation} - how to generate HTML documentation +from "XML comments" in your .NET libraries. The tool handles comments written in +Markdown too. + +\item + +\href{styling.html}{Styling} - explains some options for styling the output of \texttt{fsdocs}. + +\item + +\href{literate.html}{Using literate programming} - explains how to generate documentation +for your projects or to write nicely formatted F\# blog posts. + +\item + +\href{evaluation.html}{Embedding F\# outputs in literate programming} - provides more details on literate programming and +explains how to embed results of a literate script file in the generated output. This way, +you can easily format the results of running your code! + +\end{itemize} + +\subsection*{Using FSharp.Formatting as a library} + + + +F\# Formatting is also \href{https://nuget.org/packages/FSharp.Formatting}{available on NuGet} as a set of libraries. +\begin{itemize} +\item + +\href{markdown.html}{Markdown parser} - explains the F\# Markdown +processor that is available in this library with some basic examples of +document processing. + +\item + +\href{codeformat.html}{F\# code formatting} - more details about the F\# code +formatter and how to use it to obtain information about F\# source files. + +\end{itemize} + +\subsection*{More information} + + + +The documentation for this library is generated automatically using the tools +built here. If you spot a typo, please submit a pull request! The source Markdown and F\# script files are +available in the \href{https://github.com/fsprojects/FSharp.Formatting/tree/master/docs}{docs folder on GitHub}. + + +The project is hosted on \href{https://github.com/fsprojects/FSharp.Formatting}{GitHub} where you can +\href{https://github.com/fsprojects/FSharp.Formatting/issues}{report issues}, fork the project and submit pull requests. +See the \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/LICENSE.md}{License file} in the GitHub repository. + + +\end{document} \ No newline at end of file diff --git a/literate-notebook.fsx b/literate-notebook.fsx new file mode 100644 index 000000000..64cbf3f12 --- /dev/null +++ b/literate-notebook.fsx @@ -0,0 +1,53 @@ +(** +# Literate Notebooks + +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. + +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`. + +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. + +*) +type ContactCard = + { Name: string + Phone: string + ZipCode: string } + +// Create a new record +{ Name = "Alf"; Phone = "(555) 555-5555"; ZipCode = "90210" } +(** +

                          { Name = "Alf"\n Phone = "(555) 555-5555"\n ZipCode = "90210" }
                          Name
                          Alf
                          Phone
                          (555) 555-5555
                          ZipCode
                          90210
                          +

                          +*) + diff --git a/literate-notebook.html b/literate-notebook.html new file mode 100644 index 000000000..059cc965d --- /dev/null +++ b/literate-notebook.html @@ -0,0 +1,376 @@ + + + + + + + + + + + + + + + + + + Literate Notebooks + | FSharp.Formatting + + + + + + + + + + + + + +
                          +
                          + + + Header menu logo + FSharp.Formatting + +
                          +
                          + + + + + +
                          +
                          + +
                          +
                          + +

                          Literate Notebooks

                          +

                          Content may be created using .NET interactive 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.

                          +

                          The fsdocs tool uses 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.

                          +

                          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.

                          +
                          type ContactCard =
+    { Name: string
+      Phone: string
+      ZipCode: string }
+
+// Create a new record
+{ Name = "Alf"; Phone = "(555) 555-5555"; ZipCode = "90210" }
+
                          +

                          { Name = "Alf"\n Phone = "(555) 555-5555"\n ZipCode = "90210" }
                          Name
                          Alf
                          Phone
                          (555) 555-5555
                          ZipCode
                          90210
                          +

                          + +
                          type ContactCard = + { + Name: string + Phone: string + ZipCode: string + }
                          +
                          Multiple items
                          val string: value: 'T -> string

                          --------------------
                          type string = System.String
                          + +
                          +
                          + + + +
                          +
                            +

                            Type something to start searching.

                            +
                            +                             + + + + + + + + \ No newline at end of file diff --git a/literate-notebook.ipynb b/literate-notebook.ipynb new file mode 100644 index 000000000..2aab5d95e --- /dev/null +++ b/literate-notebook.ipynb @@ -0,0 +1,118 @@ + +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + + "source": [ + "# Literate Notebooks\n", + "\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 [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\u0027s native appearance when generating documents. Notebook cell outputs are passed through unchanged to preserve the notebook\u0027s html output. The below snippet demonstrates a notebook\u0027s html output for F# records, which differs from the output you would get with the same code inside a literate scripts.\n", + "\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "type ContactCard =\n", + " { Name: string\n", + " Phone: string\n", + " ZipCode: string }\n", + "\n", + "// Create a new record\n", + "{ Name = \"Alf\"; Phone = \"(555) 555-5555\"; ZipCode = \"90210\" }\n" + ] + } +, + { + "cell_type": "code", + "metadata": { + "dotnet_interactive": { + "language": "fsharp" + }, + "polyglot_notebook": { + "kernelName": "fsharp" + } + }, + "execution_count": null, "outputs": [], + "source": [ + "\u003cp\u003e\u003cdetails open=\"open\" class=\"dni-treeview\"\u003e\u003csummary\u003e\u003cspan class=\"dni-code-hint\"\u003e\u003ccode\u003e{ Name = \u0026quot;Alf\u0026quot;\\n Phone = \u0026quot;(555) 555-5555\u0026quot;\\n ZipCode = \u0026quot;90210\u0026quot; }\u003c/code\u003e\u003c/span\u003e\u003c/summary\u003e\u003cdiv\u003e\u003ctable\u003e\u003cthead\u003e\u003ctr\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003ctd\u003eName\u003c/td\u003e\u003ctd\u003e\u003cdiv class=\"dni-plaintext\"\u003e\u003cpre\u003eAlf\u003c/pre\u003e\u003c/div\u003e\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003ePhone\u003c/td\u003e\u003ctd\u003e\u003cdiv class=\"dni-plaintext\"\u003e\u003cpre\u003e(555) 555-5555\u003c/pre\u003e\u003c/div\u003e\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eZipCode\u003c/td\u003e\u003ctd\u003e\u003cdiv class=\"dni-plaintext\"\u003e\u003cpre\u003e90210\u003c/pre\u003e\u003c/div\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e\u003c/details\u003e\u003cstyle\u003e\n", + ".dni-code-hint {\n", + " font-style: italic;\n", + " overflow: hidden;\n", + " white-space: nowrap;\n", + "}\n", + ".dni-treeview {\n", + " white-space: nowrap;\n", + "}\n", + ".dni-treeview td {\n", + " vertical-align: top;\n", + " text-align: start;\n", + "}\n", + "details.dni-treeview {\n", + " padding-left: 1em;\n", + "}\n", + "table td {\n", + " text-align: start;\n", + "}\n", + "table tr { \n", + " vertical-align: top; \n", + " margin: 0em 0px;\n", + "}\n", + "table tr td pre \n", + "{ \n", + " vertical-align: top !important; \n", + " margin: 0em 0px !important;\n", + "} \n", + "table th {\n", + " text-align: start;\n", + "}\n", + "\u003c/style\u003e\n", + "\u003c/p\u003e\n" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": ".NET (F#)", + "language": "F#", + "name": ".net-fsharp" + }, + "language_info": { + "file_extension": ".fs", + "mimetype": "text/x-fsharp", + "name": "polyglot-notebook", + "pygments_lexer": "fsharp" + }, + "polyglot_notebook": { + "kernelInfo": { + "defaultKernelName": "fsharp", + "items": [ + { + "aliases": [], + "languageName": "fsharp", + "name": "fsharp" + } + ] + } + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} + diff --git a/literate-notebook.md b/literate-notebook.md new file mode 100644 index 000000000..0b9b7a24f --- /dev/null +++ b/literate-notebook.md @@ -0,0 +1,52 @@ +# Literate Notebooks + +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. + +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`. + +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. + +```fsharp +type ContactCard = + { Name: string + Phone: string + ZipCode: string } + +// Create a new record +{ Name = "Alf"; Phone = "(555) 555-5555"; ZipCode = "90210" } +``` + +

                            { Name = "Alf"\n Phone = "(555) 555-5555"\n ZipCode = "90210" }
                            Name
                            Alf
                            Phone
                            (555) 555-5555
                            ZipCode
                            90210
                            +

                            + diff --git a/literate-notebook.tex b/literate-notebook.tex new file mode 100644 index 000000000..0c173a8fc --- /dev/null +++ b/literate-notebook.tex @@ -0,0 +1,106 @@ +\documentclass{article} + +\usepackage{xcolor} +\usepackage{graphicx} +\usepackage{fancyvrb} +\usepackage{listings} +\usepackage[T1]{fontenc} +\usepackage{hyperref} +\usepackage{amsmath} + +\definecolor{officegreen}{rgb}{0, 0.5, 0} +\definecolor{navy}{rgb}{0, 0, 0.5} +\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875} +\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375} + +\newcommand{\id}[1]{\textcolor{black}{#1}} +\newcommand{\com}[1]{\textcolor{officegreen}{#1}} +\newcommand{\inact}[1]{\textcolor{gray}{#1}} +\newcommand{\kwd}[1]{\textcolor{navy}{#1}} +\newcommand{\num}[1]{\textcolor{officegreen}{#1}} +\newcommand{\ops}[1]{\textcolor{purple}{#1}} +\newcommand{\prep}[1]{\textcolor{purple}{#1}} +\newcommand{\str}[1]{\textcolor{olive}{#1}} +\newcommand{\lines}[1]{\textcolor{linecolor}{#1}} +\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}} +\newcommand{\omi}[1]{\textcolor{gray}{#1}} + +% Overriding color and style of line numbers +\renewcommand{\theFancyVerbLine}{ +\lines{\small \arabic{FancyVerbLine}:}} + +\lstset{% + backgroundcolor=\color{gray!15}, + basicstyle=\ttfamily, + breaklines=true, + columns=fullflexible +} + +\title{{page-title}} +\date{} + +\begin{document} + +\maketitle + + +\section*{Literate Notebooks} + + + +Content may be created using \href{https://github.com/dotnet/interactive/tree/main}{.NET interactive} polyglot notebooks as the input file. Notebooks are processed by converting the notebook to a literate \texttt{.fsx} script and then passing the script through the script processing pipeline. Markdown notebook cells are passed through as comments surrounded by \texttt{(**} and \texttt{*)}, F\# code cells are passed through as code, and non-F\# code is passed through as markdown fenced code blocks between \texttt{(**} and \texttt{*)} comment markers. + + +The \texttt{fsdocs} tool uses \href{https://github.com/jonsequitur/dotnet-repl}{dotnet-repl} to evaluate polyglot notebooks. You need this tool to evaluate notebooks using \texttt{dotnet fsdocs [build|watch] --eval}. It can be installed into your local tool manifest using the command \texttt{dotnet tool install dotnet-repl}. + + +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. +\begin{lstlisting}[numbers=left] + +[escapeinside=\\\{\}] +\kwd{type} \ltyp{ContactCard} \ops{=} + {\{} {Name}{:} \ltyp{string} + {Phone}{:} \ltyp{string} + {ZipCode}{:} \ltyp{string} {\}} + +\com{// Create a new record} +{\{} {Name} \ops{=} \str{"Alf"}{;} {Phone} \ops{=} \str{"(555) 555-5555"}{;} {ZipCode} \ops{=} \str{"90210"} {\}} + +\end{lstlisting} + +

                            { Name = "Alf"\n Phone = "(555) 555-5555"\n ZipCode = "90210" }
                            Name
                            Alf
                            Phone
                            (555) 555-5555
                            ZipCode
                            90210
                            +

                            + + +\end{document} \ No newline at end of file diff --git a/literate.fsx b/literate.fsx new file mode 100644 index 000000000..8645a99f3 --- /dev/null +++ b/literate.fsx @@ -0,0 +1,271 @@ +(** + +*) +#r "nuget: FSharp.Formatting,1.0.0" +(** +[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=literate.ipynb)  +[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.fsx)  +[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.ipynb) + +# Literate Scripts + +The following example shows most of the features that can be used in a literate +F# script file with `.fsx` extension. Most of the features should be quite self-explanatory: + + (** + # First-level heading + Some more documentation using `Markdown`. + *) + + let helloWorld() = printfn "Hello world!" + + (** + ## Second-level heading + With some more documentation + *) + + let numbers = [ 0 .. 99 ] + (*** include-value: numbers ***) + + List.sum numbers + (*** include-it ***) + +The F# script files are processed as follows: + +* A multi-line comment starting with `(**` and ending with `*)` is +turned into text and is processed using the F# Markdown processor +(which supports standard Markdown commands). + + +* A single-line comment starting with `(***` and ending with `***)` +is treated as a special command. The command can consist of +`key`, `key: value` or `key=value` pairs. + + +Literate Command | Description +:--- | :--- +`(** ... *)` | Markdown +`(*** condition: prepare ***)` | Utilise a code snippet when analyzing for tooltips or executing for outputs +`(*** condition: ipynb ***)` | Include a code snippet when making a .ipynb notebook +`(*** condition: tex ***)` | Include a code snippet when making a .tex output +`(*** condition: html ***)` | Include a code snippet when making HTML output +`(*** hide ***)` | Hide the subsequent snippet +`(*** raw ***)` | The subsequent code is treated as raw text + + +### Naming and including snippets + +The command `define` defines a named snippet (such as `final-sample`) and removes the command together with +the following F# code block from the main document. The snippet can then +be referred to in 'include'. This makes it +possible to write documents without the ordering requirements of the +F# language. + +Literate Command | Description +:--- | :--- +`(*** define: snippet-name ***)` | Define a named snippet +`(*** include: snippet-name ***)` | Include the code of the named snippet + + +### Naming and including outputs + +Literate Command | Description +:--- | :--- +`(*** define-output: output-name ***)` | Define a name for the outputs of the preceding snippet +`(*** include-output ***)` | The console output of the preceding snippet +`(*** include-output: output-name ***)` | The console output of the snippet (named with define-output) +`(*** include-fsi-output ***)` | The F# Interactive output of the preceding snippet +`(*** include-fsi-output: output-name ***)` | The F# Interactive output of the snippet (named with define-output) +`(*** include-fsi-merged-output ***)` | The merge of console output and F# Interactive output of the preceding snippet +`(*** include-fsi-merged-output: output-name ***)` | The merge of console output and F# Interactive output of the snippet (named with define-output) +`(*** include-it ***)` | The formatted result of the preceding snippet +`(*** include-it: output-name ***)` | The formatted result of the snippet (named with define-output) +`(*** include-it-raw ***)` | The unformatted result of the preceding snippet +`(*** include-it-raw: output-name ***)` | The unformatted result of the snippet (named with define-output) +`(*** include-value: value-name ***)` | The formatted value, an F# identifier name + + +#### Hiding code snippets + +The command `hide` specifies that the following F# code block (until the next comment or command) should be +omitted from the output. + +#### Evaluating and formatting results + +The commands to evaluate and format results are explained in [evaluation](evaluation.html). +You must build your documentation with evaluation turned on using `--eval`. + +#### Substitutions + +Substitutions are applied to content, see [content](content.html). + +### Literate Markdown Documents + +For files with `.md` extension, the entire file is a Markdown document, which may +contain F# code snippets (but also other code snippets). As usual, snippets are +indented with four spaces. In addition, the snippets can be annotated with special +commands. Some of them are demonstrated in the following example: + + [lang=text] + # First-level heading + + [hide] + let print s = printfn "%s" s + + Some more documentation using `Markdown`. + + [module=Hello] + let helloWorld() = print "Hello world!" + + ## Second-level heading + With some more documentation + + [lang=csharp] + Console.WriteLine("Hello world!"); + +When processing the document, all F# snippets are copied to a separate file that +is type-checked using the F# compiler (to obtain colours and tooltips). +The commands are written on the first line of the named snippet, wrapped in `[...]`: + +* The `hide` command specifies that the F# snippet should not be included in the +final document. This can be used to include code that is needed to type-check +the code, but is not visible to the reader. + + +* The `module=Foo` command can be used to specify F# `module` where the snippet +is placed. Use this command if you need multiple versions of the same snippet +or if you need to separate code from different snippets. + + +* The `lang=foo` command specifies the language of the named snippet. If the language +is other than `fsharp`, the snippet is copied to the output as `
                            ` HTML
+tag without any processing.
+  
+
+### LaTeX in Literate Scripts and Markdown Documents
+
+Literate Scripts may contain LaTeX sections in Markdown using these forms:
+
+0 Single line latex starting with `$$`.
+  
+
+1 A block delimited by `\begin{equation}...\end{equation}` or `\begin{align}...\end{align}`.
+  
+
+2 An indented paragraph starting with `$$$`.  This is F#-literate-specific and corresponds to
+`\begin{equation}...\end{equation}`.
+  
+
+For example
+
+    [lang=text]
+    $$\frac{x}{y}$$
+
+    \begin{equation}
+       \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+    \end{equation}
+
+Becomes
+
+\begin{equation}
+\frac{x}{y}
+\end{equation}
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
+The LaTeX will also be used in HTML and iPython notebook outputs.
+
+### Making literate scripts work for different outputs
+
+Literate scripts and markdown can be turned into LaTex, Python Notebooks and F# scripts.
+
+A header may be needed to get the code to load, a typical example is this:
+
+```text
+    (*** condition: prepare ***)
+    #nowarn "211"
+    #I "../src/FSharp.Formatting/bin/Release/netstandard2.1"
+    #r "FSharp.Formatting.Common.dll"
+    #r "FSharp.Formatting.Markdown.dll"
+    #r "FSharp.Formatting.CodeFormat.dll"
+    #r "FSharp.Formatting.Literate.dll"
+    (*** condition: fsx ***)
+#if FSX
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // FSX
+    (*** condition: ipynb ***)
+#if IPYNB
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // IPYNB
+```
+
+### Processing literate files programmatically
+
+To process files use the two static methods to turn single documents into HTML
+as follows using functionality from the [Literate](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html) type:
+
+*)
+open System.IO
+open FSharp.Formatting.Literate
+
+let source = __SOURCE_DIRECTORY__
+let template = Path.Combine(source, "template.html")
+
+let script = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(script, template)
+
+let doc = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(doc, template)
+(**
+The following sample also uses the optional parameter `parameters` to specify additional
+keywords that will be replaced in the template file (this matches the `template-project.html`
+file which is included as a sample in the package):
+
+*)
+// Load the template & specify project information
+let projTemplate = source + "template-project.html"
+
+let projInfo =
+    [ "fsdocs-authors", "Tomas Petricek"
+      "fsdocs-source-link", "https://github.com/fsprojects/FSharp.Formatting"
+      "fsdocs-collection-name", "F# Formatting" ]
+(**
+The methods used above ([Literate.ConvertScriptFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertScriptFile), [Literate.ConvertMarkdownFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertMarkdownFile))
+produce HTML output by default, but they can be also used to produce LaTeX output. This is done
+by setting the output kind. The following
+example shows how to call the methods to generate LaTeX documents:
+
+*)
+let templateTex = Path.Combine(source, "template.tex")
+
+let scriptTex = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptTex, templateTex, outputKind = OutputKind.Latex)
+
+let docTex = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docTex, templateTex, outputKind = OutputKind.Latex)
+(**
+The methods used above (`ConvertScriptFile`, `ConvertMarkdownFile`)
+can also produce iPython Notebook output. This is done
+by setting the named parameter `format` to `OutputKind.Pynb`:
+
+*)
+// Process script file, Markdown document and a directory
+let scriptPynb = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptPynb, outputKind = OutputKind.Pynb)
+
+let docPynb = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docPynb, outputKind = OutputKind.Pynb)
+(**
+All of the three methods discussed in the previous two sections take a number of optional
+parameters that can be used to tweak how the formatting works
+
+*)
+
diff --git a/literate.html b/literate.html
new file mode 100644
index 000000000..397868e51
--- /dev/null
+++ b/literate.html
@@ -0,0 +1,759 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Literate Scripts
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                            
+    
                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                            
+    
                            
+        
+            
+        
+        
+        
+    
                            
+
                            
+
+
                            
+    
                            
+        
+
                            Binder 
+Script 
+Notebook
                            
+
                            Literate Scripts
                            
+
                            The following example shows most of the features that can be used in a literate
+F# script file with .fsx extension. Most of the features should be quite self-explanatory:
                            
+
                            (**
+# First-level heading
+Some more documentation using `Markdown`.
+*)
+
+let helloWorld() = printfn "Hello world!"
+
+(**
+## Second-level heading
+With some more documentation
+*)
+
+let numbers = [ 0 .. 99 ]
+(*** include-value: numbers ***)
+
+List.sum numbers
+(*** include-it ***)
+
                            
+
                            The F# script files are processed as follows:
                            
+
                              
+
                            • 
+
                              A multi-line comment starting with (** and ending with *) is
+turned into text and is processed using the F# Markdown processor
+(which supports standard Markdown commands).
                              
+
                              • 
+
                            • 
+
                              A single-line comment starting with (*** and ending with ***)
+is treated as a special command. The command can consist of
+key, key: value or key=value pairs.
                              
+
                              • 
+
                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                            Literate Command
                            Description
                            (** ... *)
                            Markdown
                            (*** condition: prepare ***)
                            Utilise a code snippet when analyzing for tooltips or executing for outputs
                            (*** condition: ipynb ***)
                            Include a code snippet when making a .ipynb notebook
                            (*** condition: tex ***)
                            Include a code snippet when making a .tex output
                            (*** condition: html ***)
                            Include a code snippet when making HTML output
                            (*** hide ***)
                            Hide the subsequent snippet
                            (*** raw ***)
                            The subsequent code is treated as raw text
                            
+
+
                            Naming and including snippets
                            
+
                            The command define defines a named snippet (such as final-sample) and removes the command together with
+the following F# code block from the main document. The snippet can then
+be referred to in 'include'. This makes it
+possible to write documents without the ordering requirements of the
+F# language.
                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                            Literate Command
                            Description
                            (*** define: snippet-name ***)
                            Define a named snippet
                            (*** include: snippet-name ***)
                            Include the code of the named snippet
                            
+
+
                            Naming and including outputs
                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                            Literate Command
                            Description
                            (*** define-output: output-name ***)
                            Define a name for the outputs of the preceding snippet
                            (*** include-output ***)
                            The console output of the preceding snippet
                            (*** include-output: output-name ***)
                            The console output of the snippet (named with define-output)
                            (*** include-fsi-output ***)
                            The F# Interactive output of the preceding snippet
                            (*** include-fsi-output: output-name ***)
                            The F# Interactive output of the snippet (named with define-output)
                            (*** include-fsi-merged-output ***)
                            The merge of console output and F# Interactive output of the preceding snippet
                            (*** include-fsi-merged-output: output-name ***)
                            The merge of console output and F# Interactive output of the snippet (named with define-output)
                            (*** include-it ***)
                            The formatted result of the preceding snippet
                            (*** include-it: output-name ***)
                            The formatted result of the snippet (named with define-output)
                            (*** include-it-raw ***)
                            The unformatted result of the preceding snippet
                            (*** include-it-raw: output-name ***)
                            The unformatted result of the snippet (named with define-output)
                            (*** include-value: value-name ***)
                            The formatted value, an F# identifier name
                            
+
+
                            Hiding code snippets
                            
+
                            The command hide specifies that the following F# code block (until the next comment or command) should be
+omitted from the output.
                            
+
                            Evaluating and formatting results
                            
+
                            The commands to evaluate and format results are explained in evaluation.
+You must build your documentation with evaluation turned on using --eval.
                            
+
                            Substitutions
                            
+
                            Substitutions are applied to content, see content.
                            
+
                            Literate Markdown Documents
                            
+
                            For files with .md extension, the entire file is a Markdown document, which may
+contain F# code snippets (but also other code snippets). As usual, snippets are
+indented with four spaces. In addition, the snippets can be annotated with special
+commands. Some of them are demonstrated in the following example:
                            
+
                            # First-level heading
+
+    [hide]
+    let print s = printfn "%s" s
+
+Some more documentation using `Markdown`.
+
+    [module=Hello]
+    let helloWorld() = print "Hello world!"
+
+## Second-level heading
+With some more documentation
+
+    [lang=csharp]
+    Console.WriteLine("Hello world!");
+
                            
+
                            When processing the document, all F# snippets are copied to a separate file that
+is type-checked using the F# compiler (to obtain colours and tooltips).
+The commands are written on the first line of the named snippet, wrapped in [...]:
                            
+
                              
+
                            • 
+
                              The hide command specifies that the F# snippet should not be included in the
+final document. This can be used to include code that is needed to type-check
+the code, but is not visible to the reader.
                              
+
                              • 
+
                            • 
+
                              The module=Foo command can be used to specify F# module where the snippet
+is placed. Use this command if you need multiple versions of the same snippet
+or if you need to separate code from different snippets.
                              
+
                              • 
+
                            • 
+
                              The lang=foo command specifies the language of the named snippet. If the language
+is other than fsharp, the snippet is copied to the output as <pre> HTML
+tag without any processing.
                              
+
                              • 
+
                            
+
                            LaTeX in Literate Scripts and Markdown Documents
                            
+
                            Literate Scripts may contain LaTeX sections in Markdown using these forms:
                            
+
                              
+
                            1. Single line latex starting with $$.
                              2. 
+
                            2. A block delimited by \begin{equation}...\end{equation} or \begin{align}...\end{align}.
                              3. 
+
                            3. 
+
                              An indented paragraph starting with $$$.  This is F#-literate-specific and corresponds to
+\begin{equation}...\end{equation}.
                              
+
                              4. 
+
                            
+
                            For example
                            
+
                            $$\frac{x}{y}$$
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
                            
+
                            Becomes
                            
+
                            \[\frac{x}{y}\]
                            
+
                            \[   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}\]
                            
+
                            The LaTeX will also be used in HTML and iPython notebook outputs.
                            
+
                            Making literate scripts work for different outputs
                            
+
                            Literate scripts and markdown can be turned into LaTex, Python Notebooks and F# scripts.
                            
+
                            A header may be needed to get the code to load, a typical example is this:
                            
+
                                (*** condition: prepare ***)
+    #nowarn "211"
+    #I "../src/FSharp.Formatting/bin/Release/netstandard2.1"
+    #r "FSharp.Formatting.Common.dll"
+    #r "FSharp.Formatting.Markdown.dll"
+    #r "FSharp.Formatting.CodeFormat.dll"
+    #r "FSharp.Formatting.Literate.dll"
+    (*** condition: fsx ***)
+#if FSX
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // FSX
+    (*** condition: ipynb ***)
+#if IPYNB
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // IPYNB
+
                            
+
                            Processing literate files programmatically
                            
+
                            To process files use the two static methods to turn single documents into HTML
+as follows using functionality from the Literate type:
                            
+
                            open System.IO
+open FSharp.Formatting.Literate
+
+let source = __SOURCE_DIRECTORY__
+let template = Path.Combine(source, "template.html")
+
+let script = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(script, template)
+
+let doc = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(doc, template)
+
                            
+
                            The following sample also uses the optional parameter parameters to specify additional
+keywords that will be replaced in the template file (this matches the template-project.html
+file which is included as a sample in the package):
                            
+
                            // Load the template & specify project information
+let projTemplate = source + "template-project.html"
+
+let projInfo =
+    [ "fsdocs-authors", "Tomas Petricek"
+      "fsdocs-source-link", "https://github.com/fsprojects/FSharp.Formatting"
+      "fsdocs-collection-name", "F# Formatting" ]
+
                            
+
                            The methods used above (Literate.ConvertScriptFile, Literate.ConvertMarkdownFile)
+produce HTML output by default, but they can be also used to produce LaTeX output. This is done
+by setting the output kind. The following
+example shows how to call the methods to generate LaTeX documents:
                            
+
                            let templateTex = Path.Combine(source, "template.tex")
+
+let scriptTex = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptTex, templateTex, outputKind = OutputKind.Latex)
+
+let docTex = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docTex, templateTex, outputKind = OutputKind.Latex)
+
                            
+
                            The methods used above (ConvertScriptFile, ConvertMarkdownFile)
+can also produce iPython Notebook output. This is done
+by setting the named parameter format to OutputKind.Pynb:
                            
+
                            // Process script file, Markdown document and a directory
+let scriptPynb = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptPynb, outputKind = OutputKind.Pynb)
+
+let docPynb = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docPynb, outputKind = OutputKind.Pynb)
+
                            
+
                            All of the three methods discussed in the previous two sections take a number of optional
+parameters that can be used to tweak how the formatting works
                            
+
+        
                            val helloWorld: unit -> unit
                            
+
                            val printfn: format: Printf.TextWriterFormat<'T> -> 'T
                            
+
                            val numbers: int list
                            
+
                            Multiple items
                            module List
+
+from Microsoft.FSharp.Collections

                            --------------------
                            type List<'T> =
+  | op_Nil
+  | op_ColonColon of Head: 'T * Tail: 'T list
+  interface IReadOnlyList<'T>
+  interface IReadOnlyCollection<'T>
+  interface IEnumerable
+  interface IEnumerable<'T>
+  member GetReverseIndex: rank: int * offset: int -> int
+  member GetSlice: startIndex: int option * endIndex: int option -> 'T list
+  static member Cons: head: 'T * tail: 'T list -> 'T list
+  member Head: 'T
+  member IsEmpty: bool
+  member Item: index: int -> 'T with get
+  ...
                            
+
                            val sum: list: 'T list -> 'T (requires member (+) and member Zero)
                            
+
                            namespace System
                            
+
                            namespace System.IO
                            
+
                            Multiple items
                            namespace FSharp

                            --------------------
                            namespace Microsoft.FSharp
                            
+
                            namespace FSharp.Formatting
                            
+
                            namespace FSharp.Formatting.Literate
                            
+
                            val source: string
                            
+
                            val template: string
                            
+
                            type Path =
+  static member ChangeExtension: path: string * extension: string -> string
+  static member Combine: path1: string * path2: string -> string + 3 overloads
+  static member EndsInDirectorySeparator: path: ReadOnlySpan<char> -> bool + 1 overload
+  static member Exists: path: string -> bool
+  static member GetDirectoryName: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload
+  static member GetExtension: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload
+  static member GetFileName: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload
+  static member GetFileNameWithoutExtension: path: ReadOnlySpan<char> -> ReadOnlySpan<char> + 1 overload
+  static member GetFullPath: path: string -> string + 1 overload
+  static member GetInvalidFileNameChars: unit -> char array
+  ...
                            <summary>Performs operations on <see cref="T:System.String" /> instances that contain file or directory path information. These operations are performed in a cross-platform manner.</summary>
                            
+
                            Path.Combine([<System.ParamArray>] paths: string array) : string
                            Path.Combine(path1: string, path2: string) : string
                            Path.Combine(path1: string, path2: string, path3: string) : string
                            Path.Combine(path1: string, path2: string, path3: string, path4: string) : string
                            
+
                            val script: string
                            
+
                            type Literate =
+  static member ConvertMarkdownFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?substitutions: (ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FrontMatterFile array -> unit
+  static member ConvertScriptFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?substitutions: (ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FrontMatterFile array -> unit
+  static member ParseAndCheckScriptFile: path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
+  static member ParseMarkdownFile: path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
+  static member ParseMarkdownString: content: string * ?path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
+  static member ParsePynbString: content: string * ?path: string * ?definedSymbols: string list * ?references: bool * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
+  static member ParseScriptString: content: string * ?path: string * ?fscOptions: string * ?definedSymbols: string list * ?references: bool * ?fsiEvaluator: IFsiEvaluator * ?parseOptions: MarkdownParseOptions * ?rootInputFolder: string * ?onError: (string -> unit) -> LiterateDocument
+  static member ToFsx: doc: LiterateDocument * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
+  static member ToHtml: doc: LiterateDocument * ?prefix: string * ?lineNumbers: bool * ?generateAnchors: bool * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?tokenKindToCss: (TokenKind -> string) -> string
+  static member ToLatex: doc: LiterateDocument * ?prefix: string * ?lineNumbers: bool * ?generateAnchors: bool * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
+  ...
                            <summary>
+ This type provides three simple methods for calling the literate programming tool.
+ The <c>ConvertMarkdownFile</c> and <c>ConvertScriptFile</c> methods process a single Markdown document
+ and F# script, respectively. The <c>ConvertDirectory</c> method handles an entire directory tree
+ (looking for <c>*.fsx</c> and <c>*.md</c> files).
+ </summary>
                            <namespacedoc><summary>Functionality to support literate programming for F# scripts</summary></namespacedoc>
                            
+
                            static member Literate.ConvertScriptFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?fsiEvaluator: Evaluation.IFsiEvaluator * ?substitutions: (FSharp.Formatting.Templating.ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FSharp.Formatting.Templating.FrontMatterFile array -> unit
                            
+
                            val doc: string
                            
+
                            static member Literate.ConvertMarkdownFile: input: string * ?template: string * ?output: string * ?outputKind: OutputKind * ?prefix: string * ?fscOptions: string * ?lineNumbers: bool * ?references: bool * ?substitutions: (FSharp.Formatting.Templating.ParamKey * string) list * ?generateAnchors: bool * ?imageSaver: (string -> string) * ?rootInputFolder: string * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?onError: (string -> unit) * ?filesWithFrontMatter: FSharp.Formatting.Templating.FrontMatterFile array -> unit
                            
+
                            val projTemplate: string
                            
+
                            val projInfo: (string * string) list
                            
+
                            val templateTex: string
                            
+
                            val scriptTex: string
                            
+
                            [<Struct>]
+type OutputKind =
+  | Html
+  | Latex
+  | Pynb
+  | Fsx
+  | Markdown
+  member Extension: string
                            <summary>
+ Defines the possible output types from literate script (HTML, Latex, Pynb)
+</summary>
                            
+
                            union case OutputKind.Latex: OutputKind
                            <summary>
+ Requests LaTeX output
+</summary>
                            
+
                            val docTex: string
                            
+
                            val scriptPynb: string
                            
+
                            union case OutputKind.Pynb: OutputKind
                            <summary>
+ Requests Notebook output
+</summary>
                            
+
                            val docPynb: string
                            
+
+    
                            
+
                            
+
+
+    
+    
                            
+        
                              
+        
                              Type something to start searching.
                              
+    
                              
+                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/literate.ipynb b/literate.ipynb
new file mode 100644
index 000000000..35f3c2a8e
--- /dev/null
+++ b/literate.ipynb
@@ -0,0 +1,413 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "#r \"nuget: FSharp.Formatting,1.0.0\"\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=literate.ipynb)\u0026emsp;\n",
+    "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.fsx)\u0026emsp;\n",
+    "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.ipynb)\n",
+    "\n",
+    "# Literate Scripts\n",
+    "\n",
+    "The following example shows most of the features that can be used in a literate\n",
+    "F# script file with `.fsx` extension. Most of the features should be quite self-explanatory:\n",
+    "\n",
+    "    (**\n",
+    "    # First-level heading\n",
+    "    Some more documentation using `Markdown`.\n",
+    "    *)\n",
+    "\n",
+    "    let helloWorld() = printfn \"Hello world!\"\n",
+    "\n",
+    "    (**\n",
+    "    ## Second-level heading\n",
+    "    With some more documentation\n",
+    "    *)\n",
+    "\n",
+    "    let numbers = [ 0 .. 99 ]\n",
+    "    (*** include-value: numbers ***)\n",
+    "\n",
+    "    List.sum numbers\n",
+    "    (*** include-it ***)\n",
+    "\n",
+    "The F# script files are processed as follows:\n",
+    "\n",
+    "* A multi-line comment starting with `(**` and ending with `*)` is\n",
+    "turned into text and is processed using the F# Markdown processor\n",
+    "(which supports standard Markdown commands).\n",
+    "  \n",
+    "\n",
+    "* A single-line comment starting with `(***` and ending with `***)`\n",
+    "is treated as a special command. The command can consist of\n",
+    "`key`, `key: value` or `key=value` pairs.\n",
+    "  \n",
+    "\n",
+    "Literate Command | Description\n",
+    ":--- | :---\n",
+    "`(** ... *)` | Markdown\n",
+    "`(*** condition: prepare ***)` | Utilise a code snippet when analyzing for tooltips or executing for outputs\n",
+    "`(*** condition: ipynb ***)` | Include a code snippet when making a .ipynb notebook\n",
+    "`(*** condition: tex ***)` | Include a code snippet when making a .tex output\n",
+    "`(*** condition: html ***)` | Include a code snippet when making HTML output\n",
+    "`(*** hide ***)` | Hide the subsequent snippet\n",
+    "`(*** raw ***)` | The subsequent code is treated as raw text\n",
+    "\n",
+    "\n",
+    "### Naming and including snippets\n",
+    "\n",
+    "The command `define` defines a named snippet (such as `final-sample`) and removes the command together with\n",
+    "the following F# code block from the main document. The snippet can then\n",
+    "be referred to in \u0027include\u0027. This makes it\n",
+    "possible to write documents without the ordering requirements of the\n",
+    "F# language.\n",
+    "\n",
+    "Literate Command | Description\n",
+    ":--- | :---\n",
+    "`(*** define: snippet-name ***)` | Define a named snippet\n",
+    "`(*** include: snippet-name ***)` | Include the code of the named snippet\n",
+    "\n",
+    "\n",
+    "### Naming and including outputs\n",
+    "\n",
+    "Literate Command | Description\n",
+    ":--- | :---\n",
+    "`(*** define-output: output-name ***)` | Define a name for the outputs of the preceding snippet\n",
+    "`(*** include-output ***)` | The console output of the preceding snippet\n",
+    "`(*** include-output: output-name ***)` | The console output of the snippet (named with define-output)\n",
+    "`(*** include-fsi-output ***)` | The F# Interactive output of the preceding snippet\n",
+    "`(*** include-fsi-output: output-name ***)` | The F# Interactive output of the snippet (named with define-output)\n",
+    "`(*** include-fsi-merged-output ***)` | The merge of console output and F# Interactive output of the preceding snippet\n",
+    "`(*** include-fsi-merged-output: output-name ***)` | The merge of console output and F# Interactive output of the snippet (named with define-output)\n",
+    "`(*** include-it ***)` | The formatted result of the preceding snippet\n",
+    "`(*** include-it: output-name ***)` | The formatted result of the snippet (named with define-output)\n",
+    "`(*** include-it-raw ***)` | The unformatted result of the preceding snippet\n",
+    "`(*** include-it-raw: output-name ***)` | The unformatted result of the snippet (named with define-output)\n",
+    "`(*** include-value: value-name ***)` | The formatted value, an F# identifier name\n",
+    "\n",
+    "\n",
+    "#### Hiding code snippets\n",
+    "\n",
+    "The command `hide` specifies that the following F# code block (until the next comment or command) should be\n",
+    "omitted from the output.\n",
+    "\n",
+    "#### Evaluating and formatting results\n",
+    "\n",
+    "The commands to evaluate and format results are explained in [evaluation](evaluation.html).\n",
+    "You must build your documentation with evaluation turned on using `--eval`.\n",
+    "\n",
+    "#### Substitutions\n",
+    "\n",
+    "Substitutions are applied to content, see [content](content.html).\n",
+    "\n",
+    "### Literate Markdown Documents\n",
+    "\n",
+    "For files with `.md` extension, the entire file is a Markdown document, which may\n",
+    "contain F# code snippets (but also other code snippets). As usual, snippets are\n",
+    "indented with four spaces. In addition, the snippets can be annotated with special\n",
+    "commands. Some of them are demonstrated in the following example:\n",
+    "\n",
+    "    [lang=text]\n",
+    "    # First-level heading\n",
+    "\n",
+    "        [hide]\n",
+    "        let print s = printfn \"%s\" s\n",
+    "\n",
+    "    Some more documentation using `Markdown`.\n",
+    "\n",
+    "        [module=Hello]\n",
+    "        let helloWorld() = print \"Hello world!\"\n",
+    "\n",
+    "    ## Second-level heading\n",
+    "    With some more documentation\n",
+    "\n",
+    "        [lang=csharp]\n",
+    "        Console.WriteLine(\"Hello world!\");\n",
+    "\n",
+    "When processing the document, all F# snippets are copied to a separate file that\n",
+    "is type-checked using the F# compiler (to obtain colours and tooltips).\n",
+    "The commands are written on the first line of the named snippet, wrapped in `[...]`:\n",
+    "\n",
+    "* The `hide` command specifies that the F# snippet should not be included in the\n",
+    "final document. This can be used to include code that is needed to type-check\n",
+    "the code, but is not visible to the reader.\n",
+    "  \n",
+    "\n",
+    "* The `module=Foo` command can be used to specify F# `module` where the snippet\n",
+    "is placed. Use this command if you need multiple versions of the same snippet\n",
+    "or if you need to separate code from different snippets.\n",
+    "  \n",
+    "\n",
+    "* The `lang=foo` command specifies the language of the named snippet. If the language\n",
+    "is other than `fsharp`, the snippet is copied to the output as `\u003cpre\u003e` HTML\n",
+    "tag without any processing.\n",
+    "  \n",
+    "\n",
+    "### LaTeX in Literate Scripts and Markdown Documents\n",
+    "\n",
+    "Literate Scripts may contain LaTeX sections in Markdown using these forms:\n",
+    "\n",
+    "0 Single line latex starting with `$$`.\n",
+    "  \n",
+    "\n",
+    "1 A block delimited by `\\begin{equation}...\\end{equation}` or `\\begin{align}...\\end{align}`.\n",
+    "  \n",
+    "\n",
+    "2 An indented paragraph starting with `$$$`.  This is F#-literate-specific and corresponds to\n",
+    "`\\begin{equation}...\\end{equation}`.\n",
+    "  \n",
+    "\n",
+    "For example\n",
+    "\n",
+    "    [lang=text]\n",
+    "    $$\\frac{x}{y}$$\n",
+    "\n",
+    "    \\begin{equation}\n",
+    "       \\frac{d}{dx} \\left. \\left( x \\left( \\left. \\frac{d}{dy} x y \\; \\right|_{y=3} \\right) \\right) \\right|_{x=2}\n",
+    "    \\end{equation}\n",
+    "\n",
+    "Becomes\n",
+    "\n",
+    "\\begin{equation}\n",
+    "\\frac{x}{y}\n",
+    "\\end{equation}\n",
+    "\n",
+    "\\begin{equation}\n",
+    "   \\frac{d}{dx} \\left. \\left( x \\left( \\left. \\frac{d}{dy} x y \\; \\right|_{y=3} \\right) \\right) \\right|_{x=2}\n",
+    "\\end{equation}\n",
+    "\n",
+    "The LaTeX will also be used in HTML and iPython notebook outputs.\n",
+    "\n",
+    "### Making literate scripts work for different outputs\n",
+    "\n",
+    "Literate scripts and markdown can be turned into LaTex, Python Notebooks and F# scripts.\n",
+    "\n",
+    "A header may be needed to get the code to load, a typical example is this:\n",
+    "\n",
+    "```text\n",
+    "    (*** condition: prepare ***)\n",
+    "    #nowarn \"211\"\n",
+    "    #I \"../src/FSharp.Formatting/bin/Release/netstandard2.1\"\n",
+    "    #r \"FSharp.Formatting.Common.dll\"\n",
+    "    #r \"FSharp.Formatting.Markdown.dll\"\n",
+    "    #r \"FSharp.Formatting.CodeFormat.dll\"\n",
+    "    #r \"FSharp.Formatting.Literate.dll\"\n",
+    "    (*** condition: fsx ***)\n",
+    "#if FSX\n",
+    "    #r \"nuget: FSharp.Formatting,1.0.0\"\n",
+    "#endif // FSX\n",
+    "    (*** condition: ipynb ***)\n",
+    "#if IPYNB\n",
+    "    #r \"nuget: FSharp.Formatting,1.0.0\"\n",
+    "#endif // IPYNB\n",
+    "```\n",
+    "\n",
+    "### Processing literate files programmatically\n",
+    "\n",
+    "To process files use the two static methods to turn single documents into HTML\n",
+    "as follows using functionality from the [Literate](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html) type:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "open System.IO\n",
+    "open FSharp.Formatting.Literate\n",
+    "\n",
+    "let source = __SOURCE_DIRECTORY__\n",
+    "let template = Path.Combine(source, \"template.html\")\n",
+    "\n",
+    "let script = Path.Combine(source, \"../docs/script.fsx\")\n",
+    "\n",
+    "Literate.ConvertScriptFile(script, template)\n",
+    "\n",
+    "let doc = Path.Combine(source, \"../docs/document.md\")\n",
+    "\n",
+    "Literate.ConvertMarkdownFile(doc, template)\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The following sample also uses the optional parameter `parameters` to specify additional\n",
+    "keywords that will be replaced in the template file (this matches the `template-project.html`\n",
+    "file which is included as a sample in the package):\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "// Load the template \u0026 specify project information\n",
+    "let projTemplate = source + \"template-project.html\"\n",
+    "\n",
+    "let projInfo =\n",
+    "    [ \"fsdocs-authors\", \"Tomas Petricek\"\n",
+    "      \"fsdocs-source-link\", \"https://github.com/fsprojects/FSharp.Formatting\"\n",
+    "      \"fsdocs-collection-name\", \"F# Formatting\" ]\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The methods used above ([Literate.ConvertScriptFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertScriptFile), [Literate.ConvertMarkdownFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertMarkdownFile))\n",
+    "produce HTML output by default, but they can be also used to produce LaTeX output. This is done\n",
+    "by setting the output kind. The following\n",
+    "example shows how to call the methods to generate LaTeX documents:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let templateTex = Path.Combine(source, \"template.tex\")\n",
+    "\n",
+    "let scriptTex = Path.Combine(source, \"../docs/script.fsx\")\n",
+    "\n",
+    "Literate.ConvertScriptFile(scriptTex, templateTex, outputKind = OutputKind.Latex)\n",
+    "\n",
+    "let docTex = Path.Combine(source, \"../docs/document.md\")\n",
+    "\n",
+    "Literate.ConvertMarkdownFile(docTex, templateTex, outputKind = OutputKind.Latex)\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The methods used above (`ConvertScriptFile`, `ConvertMarkdownFile`)\n",
+    "can also produce iPython Notebook output. This is done\n",
+    "by setting the named parameter `format` to `OutputKind.Pynb`:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "// Process script file, Markdown document and a directory\n",
+    "let scriptPynb = Path.Combine(source, \"../docs/script.fsx\")\n",
+    "\n",
+    "Literate.ConvertScriptFile(scriptPynb, outputKind = OutputKind.Pynb)\n",
+    "\n",
+    "let docPynb = Path.Combine(source, \"../docs/document.md\")\n",
+    "\n",
+    "Literate.ConvertMarkdownFile(docPynb, outputKind = OutputKind.Pynb)\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "All of the three methods discussed in the previous two sections take a number of optional\n",
+    "parameters that can be used to tweak how the formatting works\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/literate.md b/literate.md
new file mode 100644
index 000000000..ccc943434
--- /dev/null
+++ b/literate.md
@@ -0,0 +1,268 @@
+[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=literate.ipynb) 
+[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.fsx) 
+[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//literate.ipynb)
+
+# Literate Scripts
+
+The following example shows most of the features that can be used in a literate
+F# script file with `.fsx` extension. Most of the features should be quite self-explanatory:
+
+```fsharp
+(**
+# First-level heading
+Some more documentation using `Markdown`.
+*)
+
+let helloWorld() = printfn "Hello world!"
+
+(**
+## Second-level heading
+With some more documentation
+*)
+
+let numbers = [ 0 .. 99 ]
+(*** include-value: numbers ***)
+
+List.sum numbers
+(*** include-it ***)
+
+```
+
+The F# script files are processed as follows:
+
+* A multi-line comment starting with `(**` and ending with `*)` is
+turned into text and is processed using the F# Markdown processor
+(which supports standard Markdown commands).
+  
+
+* A single-line comment starting with `(***` and ending with `***)`
+is treated as a special command. The command can consist of
+`key`, `key: value` or `key=value` pairs.
+  
+
+Literate Command | Description
+:--- | :---
+`(** ... *)` | Markdown
+`(*** condition: prepare ***)` | Utilise a code snippet when analyzing for tooltips or executing for outputs
+`(*** condition: ipynb ***)` | Include a code snippet when making a .ipynb notebook
+`(*** condition: tex ***)` | Include a code snippet when making a .tex output
+`(*** condition: html ***)` | Include a code snippet when making HTML output
+`(*** hide ***)` | Hide the subsequent snippet
+`(*** raw ***)` | The subsequent code is treated as raw text
+
+
+### Naming and including snippets
+
+The command `define` defines a named snippet (such as `final-sample`) and removes the command together with
+the following F# code block from the main document. The snippet can then
+be referred to in 'include'. This makes it
+possible to write documents without the ordering requirements of the
+F# language.
+
+Literate Command | Description
+:--- | :---
+`(*** define: snippet-name ***)` | Define a named snippet
+`(*** include: snippet-name ***)` | Include the code of the named snippet
+
+
+### Naming and including outputs
+
+Literate Command | Description
+:--- | :---
+`(*** define-output: output-name ***)` | Define a name for the outputs of the preceding snippet
+`(*** include-output ***)` | The console output of the preceding snippet
+`(*** include-output: output-name ***)` | The console output of the snippet (named with define-output)
+`(*** include-fsi-output ***)` | The F# Interactive output of the preceding snippet
+`(*** include-fsi-output: output-name ***)` | The F# Interactive output of the snippet (named with define-output)
+`(*** include-fsi-merged-output ***)` | The merge of console output and F# Interactive output of the preceding snippet
+`(*** include-fsi-merged-output: output-name ***)` | The merge of console output and F# Interactive output of the snippet (named with define-output)
+`(*** include-it ***)` | The formatted result of the preceding snippet
+`(*** include-it: output-name ***)` | The formatted result of the snippet (named with define-output)
+`(*** include-it-raw ***)` | The unformatted result of the preceding snippet
+`(*** include-it-raw: output-name ***)` | The unformatted result of the snippet (named with define-output)
+`(*** include-value: value-name ***)` | The formatted value, an F# identifier name
+
+
+#### Hiding code snippets
+
+The command `hide` specifies that the following F# code block (until the next comment or command) should be
+omitted from the output.
+
+#### Evaluating and formatting results
+
+The commands to evaluate and format results are explained in [evaluation](evaluation.html).
+You must build your documentation with evaluation turned on using `--eval`.
+
+#### Substitutions
+
+Substitutions are applied to content, see [content](content.html).
+
+### Literate Markdown Documents
+
+For files with `.md` extension, the entire file is a Markdown document, which may
+contain F# code snippets (but also other code snippets). As usual, snippets are
+indented with four spaces. In addition, the snippets can be annotated with special
+commands. Some of them are demonstrated in the following example:
+
+# First-level heading
+
+    [hide]
+    let print s = printfn "%s" s
+
+Some more documentation using `Markdown`.
+
+    [module=Hello]
+    let helloWorld() = print "Hello world!"
+
+## Second-level heading
+With some more documentation
+
+    [lang=csharp]
+    Console.WriteLine("Hello world!");
+
+When processing the document, all F# snippets are copied to a separate file that
+is type-checked using the F# compiler (to obtain colours and tooltips).
+The commands are written on the first line of the named snippet, wrapped in `[...]`:
+
+* The `hide` command specifies that the F# snippet should not be included in the
+final document. This can be used to include code that is needed to type-check
+the code, but is not visible to the reader.
+  
+
+* The `module=Foo` command can be used to specify F# `module` where the snippet
+is placed. Use this command if you need multiple versions of the same snippet
+or if you need to separate code from different snippets.
+  
+
+* The `lang=foo` command specifies the language of the named snippet. If the language
+is other than `fsharp`, the snippet is copied to the output as `
                              ` HTML
+tag without any processing.
+  
+
+### LaTeX in Literate Scripts and Markdown Documents
+
+Literate Scripts may contain LaTeX sections in Markdown using these forms:
+
+0 Single line latex starting with `$$`.
+  
+
+1 A block delimited by `\begin{equation}...\end{equation}` or `\begin{align}...\end{align}`.
+  
+
+2 An indented paragraph starting with `$$$`.  This is F#-literate-specific and corresponds to
+`\begin{equation}...\end{equation}`.
+  
+
+For example
+
+$$\frac{x}{y}$$
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
+Becomes
+
+\begin{equation}
+\frac{x}{y}
+\end{equation}
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
+The LaTeX will also be used in HTML and iPython notebook outputs.
+
+### Making literate scripts work for different outputs
+
+Literate scripts and markdown can be turned into LaTex, Python Notebooks and F# scripts.
+
+A header may be needed to get the code to load, a typical example is this:
+
+    (*** condition: prepare ***)
+    #nowarn "211"
+    #I "../src/FSharp.Formatting/bin/Release/netstandard2.1"
+    #r "FSharp.Formatting.Common.dll"
+    #r "FSharp.Formatting.Markdown.dll"
+    #r "FSharp.Formatting.CodeFormat.dll"
+    #r "FSharp.Formatting.Literate.dll"
+    (*** condition: fsx ***)
+#if FSX
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // FSX
+    (*** condition: ipynb ***)
+#if IPYNB
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // IPYNB
+
+### Processing literate files programmatically
+
+To process files use the two static methods to turn single documents into HTML
+as follows using functionality from the [Literate](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html) type:
+
+```fsharp
+open System.IO
+open FSharp.Formatting.Literate
+
+let source = __SOURCE_DIRECTORY__
+let template = Path.Combine(source, "template.html")
+
+let script = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(script, template)
+
+let doc = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(doc, template)
+```
+
+The following sample also uses the optional parameter `parameters` to specify additional
+keywords that will be replaced in the template file (this matches the `template-project.html`
+file which is included as a sample in the package):
+
+```fsharp
+// Load the template & specify project information
+let projTemplate = source + "template-project.html"
+
+let projInfo =
+    [ "fsdocs-authors", "Tomas Petricek"
+      "fsdocs-source-link", "https://github.com/fsprojects/FSharp.Formatting"
+      "fsdocs-collection-name", "F# Formatting" ]
+```
+
+The methods used above ([Literate.ConvertScriptFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertScriptFile), [Literate.ConvertMarkdownFile](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html#ConvertMarkdownFile))
+produce HTML output by default, but they can be also used to produce LaTeX output. This is done
+by setting the output kind. The following
+example shows how to call the methods to generate LaTeX documents:
+
+```fsharp
+let templateTex = Path.Combine(source, "template.tex")
+
+let scriptTex = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptTex, templateTex, outputKind = OutputKind.Latex)
+
+let docTex = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docTex, templateTex, outputKind = OutputKind.Latex)
+```
+
+The methods used above (`ConvertScriptFile`, `ConvertMarkdownFile`)
+can also produce iPython Notebook output. This is done
+by setting the named parameter `format` to `OutputKind.Pynb`:
+
+```fsharp
+// Process script file, Markdown document and a directory
+let scriptPynb = Path.Combine(source, "../docs/script.fsx")
+
+Literate.ConvertScriptFile(scriptPynb, outputKind = OutputKind.Pynb)
+
+let docPynb = Path.Combine(source, "../docs/document.md")
+
+Literate.ConvertMarkdownFile(docPynb, outputKind = OutputKind.Pynb)
+```
+
+All of the three methods discussed in the previous two sections take a number of optional
+parameters that can be used to tweak how the formatting works
+
+
diff --git a/literate.tex b/literate.tex
new file mode 100644
index 000000000..7b0f575e7
--- /dev/null
+++ b/literate.tex
@@ -0,0 +1,392 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+
+
+\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=literate.ipynb}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-binder.svg}
+\caption{Binder}
+\end{figure}
+} 
+\href{https://fsprojects.github.io/FSharp.Formatting//literate.fsx}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-script.svg}
+\caption{Script}
+\end{figure}
+} 
+\href{https://fsprojects.github.io/FSharp.Formatting//literate.ipynb}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg}
+\caption{Notebook}
+\end{figure}
+}
+\section*{Literate Scripts}
+
+
+
+The following example shows most of the features that can be used in a literate
+F\# script file with \texttt{.fsx} extension. Most of the features should be quite self-explanatory:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{(**}
+\com{\# First-level heading}
+\com{Some more documentation using `Markdown`.}
+\com{*)}
+
+\kwd{let} \lfun{helloWorld}{(}{)} \ops{=} \lfun{printfn} \str{"Hello world!"}
+
+\com{(**}
+\com{\#\# Second-level heading}
+\com{With some more documentation}
+\com{*)}
+
+\kwd{let} \id{numbers} \ops{=} {[} \num{0} \ops{..} \num{99} {]}
+\com{(*** include-value: numbers ***)}
+
+\ltyp{List}{.}\id{sum} \id{numbers}
+\com{(*** include-it ***)}
+
+
+\end{lstlisting}
+
+
+
+The F\# script files are processed as follows:
+\begin{itemize}
+\item 
+
+A multi-line comment starting with \texttt{(**} and ending with \texttt{*)} is
+turned into text and is processed using the F\# Markdown processor
+(which supports standard Markdown commands).
+
+\item 
+
+A single-line comment starting with \texttt{(***} and ending with \texttt{***)}
+is treated as a special command. The command can consist of
+\texttt{key}, \texttt{key: value} or \texttt{key=value} pairs.
+
+\end{itemize}
+
+\begin{tabular}{|l|l|}\hline
+\textbf{Literate Command} & \textbf{Description}\\ \hline\hline
+\texttt{(** ... *)} & Markdown\\ \hline
+\texttt{(*** condition: prepare ***)} & Utilise a code snippet when analyzing for tooltips or executing for outputs\\ \hline
+\texttt{(*** condition: ipynb ***)} & Include a code snippet when making a .ipynb notebook\\ \hline
+\texttt{(*** condition: tex ***)} & Include a code snippet when making a .tex output\\ \hline
+\texttt{(*** condition: html ***)} & Include a code snippet when making HTML output\\ \hline
+\texttt{(*** hide ***)} & Hide the subsequent snippet\\ \hline
+\texttt{(*** raw ***)} & The subsequent code is treated as raw text\\ \hline
+\end{tabular}
+
+\subsubsection*{Naming and including snippets}
+
+
+
+The command \texttt{define} defines a named snippet (such as \texttt{final-sample}) and removes the command together with
+the following F\# code block from the main document. The snippet can then
+be referred to in 'include'. This makes it
+possible to write documents without the ordering requirements of the
+F\# language.
+\begin{tabular}{|l|l|}\hline
+\textbf{Literate Command} & \textbf{Description}\\ \hline\hline
+\texttt{(*** define: snippet-name ***)} & Define a named snippet\\ \hline
+\texttt{(*** include: snippet-name ***)} & Include the code of the named snippet\\ \hline
+\end{tabular}
+
+\subsubsection*{Naming and including outputs}
+
+\begin{tabular}{|l|l|}\hline
+\textbf{Literate Command} & \textbf{Description}\\ \hline\hline
+\texttt{(*** define-output: output-name ***)} & Define a name for the outputs of the preceding snippet\\ \hline
+\texttt{(*** include-output ***)} & The console output of the preceding snippet\\ \hline
+\texttt{(*** include-output: output-name ***)} & The console output of the snippet (named with define-output)\\ \hline
+\texttt{(*** include-fsi-output ***)} & The F\# Interactive output of the preceding snippet\\ \hline
+\texttt{(*** include-fsi-output: output-name ***)} & The F\# Interactive output of the snippet (named with define-output)\\ \hline
+\texttt{(*** include-fsi-merged-output ***)} & The merge of console output and F\# Interactive output of the preceding snippet\\ \hline
+\texttt{(*** include-fsi-merged-output: output-name ***)} & The merge of console output and F\# Interactive output of the snippet (named with define-output)\\ \hline
+\texttt{(*** include-it ***)} & The formatted result of the preceding snippet\\ \hline
+\texttt{(*** include-it: output-name ***)} & The formatted result of the snippet (named with define-output)\\ \hline
+\texttt{(*** include-it-raw ***)} & The unformatted result of the preceding snippet\\ \hline
+\texttt{(*** include-it-raw: output-name ***)} & The unformatted result of the snippet (named with define-output)\\ \hline
+\texttt{(*** include-value: value-name ***)} & The formatted value, an F\# identifier name\\ \hline
+\end{tabular}
+
+\paragraph{Hiding code snippets}
+
+
+
+The command \texttt{hide} specifies that the following F\# code block (until the next comment or command) should be
+omitted from the output.
+\paragraph{Evaluating and formatting results}
+
+
+
+The commands to evaluate and format results are explained in \href{evaluation.html}{evaluation}.
+You must build your documentation with evaluation turned on using \texttt{--eval}.
+\paragraph{Substitutions}
+
+
+
+Substitutions are applied to content, see \href{content.html}{content}.
+\subsubsection*{Literate Markdown Documents}
+
+
+
+For files with \texttt{.md} extension, the entire file is a Markdown document, which may
+contain F\# code snippets (but also other code snippets). As usual, snippets are
+indented with four spaces. In addition, the snippets can be annotated with special
+commands. Some of them are demonstrated in the following example:
+\begin{lstlisting}
+# First-level heading
+
+    [hide]
+    let print s = printfn "%s" s
+
+Some more documentation using `Markdown`.
+
+    [module=Hello]
+    let helloWorld() = print "Hello world!"
+
+## Second-level heading
+With some more documentation
+
+    [lang=csharp]
+    Console.WriteLine("Hello world!");
+
+\end{lstlisting}
+
+
+When processing the document, all F\# snippets are copied to a separate file that
+is type-checked using the F\# compiler (to obtain colours and tooltips).
+The commands are written on the first line of the named snippet, wrapped in \texttt{[...]}:
+\begin{itemize}
+\item 
+
+The \texttt{hide} command specifies that the F\# snippet should not be included in the
+final document. This can be used to include code that is needed to type-check
+the code, but is not visible to the reader.
+
+\item 
+
+The \texttt{module=Foo} command can be used to specify F\# \texttt{module} where the snippet
+is placed. Use this command if you need multiple versions of the same snippet
+or if you need to separate code from different snippets.
+
+\item 
+
+The \texttt{lang=foo} command specifies the language of the named snippet. If the language
+is other than \texttt{fsharp}, the snippet is copied to the output as \texttt{
                              } HTML
+tag without any processing.
+
+\end{itemize}
+
+\subsubsection*{LaTeX in Literate Scripts and Markdown Documents}
+
+
+
+Literate Scripts may contain LaTeX sections in Markdown using these forms:
+\begin{enumerate}
+\item 
+
+Single line latex starting with \texttt{\$\$}.
+
+\item 
+
+A block delimited by \texttt{{\textbackslash}begin\{equation\}...{\textbackslash}end\{equation\}} or \texttt{{\textbackslash}begin\{align\}...{\textbackslash}end\{align\}}.
+
+\item 
+
+An indented paragraph starting with \texttt{\$\$\$}.  This is F\#-literate-specific and corresponds to
+\texttt{{\textbackslash}begin\{equation\}...{\textbackslash}end\{equation\}}.
+
+\end{enumerate}
+
+
+
+For example
+\begin{lstlisting}
+$$\frac{x}{y}$$
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
+\end{lstlisting}
+
+
+Becomes
+
+
+\begin{equation}
+\frac{x}{y}
+\end{equation}
+
+
+
+
+\begin{equation}
+   \frac{d}{dx} \left. \left( x \left( \left. \frac{d}{dy} x y \; \right|_{y=3} \right) \right) \right|_{x=2}
+\end{equation}
+
+
+
+
+The LaTeX will also be used in HTML and iPython notebook outputs.
+\subsubsection*{Making literate scripts work for different outputs}
+
+
+
+Literate scripts and markdown can be turned into LaTex, Python Notebooks and F\# scripts.
+
+
+A header may be needed to get the code to load, a typical example is this:
+\begin{lstlisting}
+    (*** condition: prepare ***)
+    #nowarn "211"
+    #I "../src/FSharp.Formatting/bin/Release/netstandard2.1"
+    #r "FSharp.Formatting.Common.dll"
+    #r "FSharp.Formatting.Markdown.dll"
+    #r "FSharp.Formatting.CodeFormat.dll"
+    #r "FSharp.Formatting.Literate.dll"
+    (*** condition: fsx ***)
+#if FSX
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // FSX
+    (*** condition: ipynb ***)
+#if IPYNB
+    #r "nuget: FSharp.Formatting,1.0.0"
+#endif // IPYNB
+
+\end{lstlisting}
+\subsubsection*{Processing literate files programmatically}
+
+
+
+To process files use the two static methods to turn single documents into HTML
+as follows using functionality from the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html}{Literate} type:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{open} \id{System}{.}\id{IO}
+\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Literate}
+
+\kwd{let} \id{source} \ops{=} \kwd{\_\_SOURCE\_DIRECTORY\_\_}
+\kwd{let} \id{template} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"template.html"}{)}
+
+\kwd{let} \id{script} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/script.fsx"}{)}
+
+\ltyp{Literate}{.}\id{ConvertScriptFile}{(}\id{script}{,} \id{template}{)}
+
+\kwd{let} \id{doc} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/document.md"}{)}
+
+\ltyp{Literate}{.}\id{ConvertMarkdownFile}{(}\id{doc}{,} \id{template}{)}
+
+\end{lstlisting}
+
+
+
+The following sample also uses the optional parameter \texttt{parameters} to specify additional
+keywords that will be replaced in the template file (this matches the \texttt{template-project.html}
+file which is included as a sample in the package):
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{// Load the template \& specify project information}
+\kwd{let} \id{projTemplate} \ops{=} \id{source} \ops{+} \str{"template-project.html"}
+
+\kwd{let} \id{projInfo} \ops{=}
+    {[} \str{"fsdocs-authors"}{,} \str{"Tomas Petricek"}
+      \str{"fsdocs-source-link"}{,} \str{"https://github.com/fsprojects/FSharp.Formatting"}
+      \str{"fsdocs-collection-name"}{,} \str{"F\# Formatting"} {]}
+
+\end{lstlisting}
+
+
+
+The methods used above (\href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html\#ConvertScriptFile}{Literate.ConvertScriptFile}, \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-literate-literate.html\#ConvertMarkdownFile}{Literate.ConvertMarkdownFile})
+produce HTML output by default, but they can be also used to produce LaTeX output. This is done
+by setting the output kind. The following
+example shows how to call the methods to generate LaTeX documents:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{templateTex} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"template.tex"}{)}
+
+\kwd{let} \id{scriptTex} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/script.fsx"}{)}
+
+\ltyp{Literate}{.}\id{ConvertScriptFile}{(}\id{scriptTex}{,} \id{templateTex}{,} \lfun{outputKind} \ops{=} \ltyp{OutputKind}{.}\id{Latex}{)}
+
+\kwd{let} \id{docTex} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/document.md"}{)}
+
+\ltyp{Literate}{.}\id{ConvertMarkdownFile}{(}\id{docTex}{,} \id{templateTex}{,} \lfun{outputKind} \ops{=} \ltyp{OutputKind}{.}\id{Latex}{)}
+
+\end{lstlisting}
+
+
+
+The methods used above (\texttt{ConvertScriptFile}, \texttt{ConvertMarkdownFile})
+can also produce iPython Notebook output. This is done
+by setting the named parameter \texttt{format} to \texttt{OutputKind.Pynb}:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{// Process script file, Markdown document and a directory}
+\kwd{let} \id{scriptPynb} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/script.fsx"}{)}
+
+\ltyp{Literate}{.}\id{ConvertScriptFile}{(}\id{scriptPynb}{,} \lfun{outputKind} \ops{=} \ltyp{OutputKind}{.}\id{Pynb}{)}
+
+\kwd{let} \id{docPynb} \ops{=} \ltyp{Path}{.}\id{Combine}{(}\id{source}{,} \str{"../docs/document.md"}{)}
+
+\ltyp{Literate}{.}\id{ConvertMarkdownFile}{(}\id{docPynb}{,} \lfun{outputKind} \ops{=} \ltyp{OutputKind}{.}\id{Pynb}{)}
+
+\end{lstlisting}
+
+
+
+All of the three methods discussed in the previous two sections take a number of optional
+parameters that can be used to tweak how the formatting works
+
+
+\end{document}
\ No newline at end of file
diff --git a/markdown.fsx b/markdown.fsx
new file mode 100644
index 000000000..fe3479527
--- /dev/null
+++ b/markdown.fsx
@@ -0,0 +1,154 @@
+(**
+
+*)
+#r "nuget: FSharp.Formatting,1.0.0"
+(**
+[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=markdown.ipynb) 
+[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.fsx) 
+[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.ipynb)
+
+# Markdown parser
+
+This page demonstrates how to use `FSharp.Formatting.Markdown` to parse a Markdown
+document, process the obtained document representation, and
+how to turn the code into a nicely formatted HTML.
+
+First, we need to load the assembly and open the necessary namespaces:
+
+*)
+open FSharp.Formatting.Markdown
+open FSharp.Formatting.Common
+(**
+## Parsing documents
+
+The F# Markdown parser recognizes the standard [Markdown syntax](http://daringfireball.net/projects/markdown/)
+and it is not the aim of this tutorial to fully document it.
+The following snippet creates a simple string containing a document
+with several elements and then parses it using the [Markdown.Parse](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#Parse) method:
+
+*)
+let document =
+    """
+# F# Hello world
+Hello world in [F#](http://fsharp.net) looks like this:
+
+    printfn "Hello world!"
+
+For more see [fsharp.org][fsorg].
+
+  [fsorg]: http://fsharp.org "The F# organization." """
+
+let parsed = Markdown.Parse(document)
+(**
+The sample document consists of a first-level heading (written using
+one of the two alternative styles) followed by a paragraph with a
+**direct** link, code snippet and one more paragraph that includes an
+**indirect** link. The URLs of indirect links are defined by a separate
+block as demonstrated on the last line (and they can then be easily used repeatedly
+from multiple places in the document).
+
+## Working with parsed documents
+
+The F# Markdown processor does not turn the document directly into HTML.
+Instead, it builds a nice F# data structure that we can use to analyze,
+transform and process the document. First of all the [MarkdownDocument.DefinedLinks](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#DefinedLinks) property
+returns all indirect link definitions:
+
+*)
+parsed.DefinedLinks
+// [fsi:val it : IDictionary =]
+// [fsi:  dict [("fsorg", ("http://fsharp.org", Some "The F# organization."))]]
+(**
+The document content can be accessed using the [MarkdownDocument.Paragraphs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#Paragraphs) property that returns
+a sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).
+The following snippet prints the heading of the document:
+
+*)
+// Iterate over all the paragraph elements
+for par in parsed.Paragraphs do
+    match par with
+    | Heading (size = 1; body = [ Literal (text = text) ]) ->
+        // Recognize heading that has a simple content
+        // containing just a literal (no other formatting)
+        printfn "%s" text
+    | _ -> ()
+(**
+You can find more detailed information about the document structure and how to process it
+in the book [F# Deep Dives](http://manning.com/petricek2/).
+
+## Processing the document recursively
+
+The library provides active patterns that can be used to easily process the Markdown
+document recursively. The example in this section shows how to extract all links from the
+document. To do that, we need to write two recursive functions. One that will process
+all paragraph-style elements and one that will process all inline formattings (inside
+paragraphs, headings etc.).
+
+To avoid pattern matching on every single kind of span and every single kind of
+paragraph, we can use active patterns from the [MarkdownPatterns](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html) module. These can be use
+to recognize any paragraph or span that can contain child elements:
+
+*)
+/// Returns all links in a specified span node
+let rec collectSpanLinks span =
+    seq {
+        match span with
+        | DirectLink (link = url) -> yield url
+        | IndirectLink (key = key) -> yield fst (parsed.DefinedLinks.[key])
+        | MarkdownPatterns.SpanLeaf _ -> ()
+        | MarkdownPatterns.SpanNode (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+/// Returns all links in the specified paragraph node
+let rec collectParLinks par =
+    seq {
+        match par with
+        | MarkdownPatterns.ParagraphLeaf _ -> ()
+        | MarkdownPatterns.ParagraphNested (_, pars) ->
+            for ps in pars do
+                for p in ps do
+                    yield! collectParLinks p
+        | MarkdownPatterns.ParagraphSpans (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+// Collect links in the entire document
+Seq.collect collectParLinks parsed.Paragraphs
+// [fsi:val it : seq =]
+// [fsi:  seq ["http://fsharp.net"; "http://fsharp.org"]]
+(**
+The `collectSpanLinks` function works on individual span elements that contain inline
+formatting (emphasis, strong) and also links. The `DirectLink` node from [MarkdownSpan](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html) represents an inline
+link like the one pointing to [http://fsharp.net](http://fsharp.net) while `IndirectLink` represents a
+link that uses one of the link definitions. The function simply returns the URL associated
+with the link.
+
+Some span nodes (like emphasis) can contain other formatting, so we need to recursively
+process children. This is done by matching against `MarkdownPatterns.SpanNodes` which is an active
+pattern that recognizes any node with children. The library also provides a **function**
+named `MarkdownPatterns.SpanNode` that can be used to reconstruct the same node (when you want
+to transform a document). This is similar to how the `ExprShape` module for working with
+F# quotations works.
+
+The function `collectParLinks` processes paragraphs - a paragraph cannot directly be a
+link so we just need to process all spans. This time, there are three options.
+`ParagraphLeaf` represents a case where the paragraph does not contain any spans
+(a code block or, for example, a `
                              ` line); the `ParagraphNested` case is used for paragraphs
+that contain other paragraphs (quotation) and `ParagraphSpans` is used for all other
+paragraphs that contain normal text - here we call `collectSpanLinks` on all nested spans.
+
+## Generating HTML output
+
+Finally, the [Markdown](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html) type also includes a method [Markdown.ToHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToHtml) that can be used
+to generate an HTML document from the Markdown input. The following example shows how to call it:
+
+*)
+let html = Markdown.ToHtml(parsed)
+(**
+There are also methods to generate `.fsx`, `.ipynb`, `.md` and `.tex`.
+
+*)
+
diff --git a/markdown.html b/markdown.html
new file mode 100644
index 000000000..f7ffd57d0
--- /dev/null
+++ b/markdown.html
@@ -0,0 +1,528 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Markdown parser
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                              
+    
                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                              
+    
                              
+        
+            
+        
+        
+        
+    
                              
+
                              
+
+
                              
+    
                              
+        
+
                              Binder 
+Script 
+Notebook
                              
+
                              Markdown parser
                              
+
                              This page demonstrates how to use FSharp.Formatting.Markdown to parse a Markdown
+document, process the obtained document representation, and
+how to turn the code into a nicely formatted HTML.
                              
+
                              First, we need to load the assembly and open the necessary namespaces:
                              
+
                              open FSharp.Formatting.Markdown
+open FSharp.Formatting.Common
+
                              
+
                              Parsing documents
                              
+
                              The F# Markdown parser recognizes the standard Markdown syntax
+and it is not the aim of this tutorial to fully document it.
+The following snippet creates a simple string containing a document
+with several elements and then parses it using the Markdown.Parse method:
                              
+
                              let document =
+    """
+# F# Hello world
+Hello world in [F#](http://fsharp.net) looks like this:
+
+    printfn "Hello world!"
+
+For more see [fsharp.org][fsorg].
+
+  [fsorg]: http://fsharp.org "The F# organization." """
+
+let parsed = Markdown.Parse(document)
+
                              
+
                              The sample document consists of a first-level heading (written using
+one of the two alternative styles) followed by a paragraph with a
+direct link, code snippet and one more paragraph that includes an
+indirect link. The URLs of indirect links are defined by a separate
+block as demonstrated on the last line (and they can then be easily used repeatedly
+from multiple places in the document).
                              
+
                              Working with parsed documents
                              
+
                              The F# Markdown processor does not turn the document directly into HTML.
+Instead, it builds a nice F# data structure that we can use to analyze,
+transform and process the document. First of all the MarkdownDocument.DefinedLinks property
+returns all indirect link definitions:
                              
+
                              parsed.DefinedLinks
+val it : IDictionary<string,(string * string option)> =
+  dict [("fsorg", ("http://fsharp.org", Some "The F# organization."))]
+
                              
+
                              The document content can be accessed using the MarkdownDocument.Paragraphs property that returns
+a sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).
+The following snippet prints the heading of the document:
                              
+
                              // Iterate over all the paragraph elements
+for par in parsed.Paragraphs do
+    match par with
+    | Heading (size = 1; body = [ Literal (text = text) ]) ->
+        // Recognize heading that has a simple content
+        // containing just a literal (no other formatting)
+        printfn "%s" text
+    | _ -> ()
+
                              
+
                              You can find more detailed information about the document structure and how to process it
+in the book F# Deep Dives.
                              
+
                              Processing the document recursively
                              
+
                              The library provides active patterns that can be used to easily process the Markdown
+document recursively. The example in this section shows how to extract all links from the
+document. To do that, we need to write two recursive functions. One that will process
+all paragraph-style elements and one that will process all inline formattings (inside
+paragraphs, headings etc.).
                              
+
                              To avoid pattern matching on every single kind of span and every single kind of
+paragraph, we can use active patterns from the MarkdownPatterns module. These can be use
+to recognize any paragraph or span that can contain child elements:
                              
+
                              /// Returns all links in a specified span node
+let rec collectSpanLinks span =
+    seq {
+        match span with
+        | DirectLink (link = url) -> yield url
+        | IndirectLink (key = key) -> yield fst (parsed.DefinedLinks.[key])
+        | MarkdownPatterns.SpanLeaf _ -> ()
+        | MarkdownPatterns.SpanNode (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+/// Returns all links in the specified paragraph node
+let rec collectParLinks par =
+    seq {
+        match par with
+        | MarkdownPatterns.ParagraphLeaf _ -> ()
+        | MarkdownPatterns.ParagraphNested (_, pars) ->
+            for ps in pars do
+                for p in ps do
+                    yield! collectParLinks p
+        | MarkdownPatterns.ParagraphSpans (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+// Collect links in the entire document
+Seq.collect collectParLinks parsed.Paragraphs
+val it : seq<string> =
+  seq ["http://fsharp.net"; "http://fsharp.org"]
+
                              
+
                              The collectSpanLinks function works on individual span elements that contain inline
+formatting (emphasis, strong) and also links. The DirectLink node from MarkdownSpan represents an inline
+link like the one pointing to http://fsharp.net while IndirectLink represents a
+link that uses one of the link definitions. The function simply returns the URL associated
+with the link.
                              
+
                              Some span nodes (like emphasis) can contain other formatting, so we need to recursively
+process children. This is done by matching against MarkdownPatterns.SpanNodes which is an active
+pattern that recognizes any node with children. The library also provides a function
+named MarkdownPatterns.SpanNode that can be used to reconstruct the same node (when you want
+to transform a document). This is similar to how the ExprShape module for working with
+F# quotations works.
                              
+
                              The function collectParLinks processes paragraphs - a paragraph cannot directly be a
+link so we just need to process all spans. This time, there are three options.
+ParagraphLeaf represents a case where the paragraph does not contain any spans
+(a code block or, for example, a <hr> line); the ParagraphNested case is used for paragraphs
+that contain other paragraphs (quotation) and ParagraphSpans is used for all other
+paragraphs that contain normal text - here we call collectSpanLinks on all nested spans.
                              
+
                              Generating HTML output
                              
+
                              Finally, the Markdown type also includes a method Markdown.ToHtml that can be used
+to generate an HTML document from the Markdown input. The following example shows how to call it:
                              
+
                              let html = Markdown.ToHtml(parsed)
+
                              
+
                              There are also methods to generate .fsx, .ipynb, .md and .tex.
                              
+
+        
                              Multiple items
                              namespace FSharp

                              --------------------
                              namespace Microsoft.FSharp
                              
+
                              namespace FSharp.Formatting
                              
+
                              namespace FSharp.Formatting.Markdown
                              
+
                              namespace FSharp.Formatting.Common
                              
+
                              val document: string
                              
+
                              val parsed: MarkdownDocument
                              
+
                              type Markdown =
+  static member Parse: text: string * ?newline: string * ?parseOptions: MarkdownParseOptions -> MarkdownDocument
+  static member ToFsx: doc: MarkdownDocument * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
+  static member ToHtml: doc: MarkdownDocument * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string + 1 overload
+  static member ToLatex: doc: MarkdownDocument * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?lineNumbers: bool -> string + 1 overload
+  static member ToMd: doc: MarkdownDocument * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
+  static member ToPynb: doc: MarkdownDocument * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
+  static member WriteHtml: doc: MarkdownDocument * writer: TextWriter * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> unit + 1 overload
+  static member WriteLatex: doc: MarkdownDocument * writer: TextWriter * ?newline: string * ?substitutions: (ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) * ?lineNumbers: bool -> unit + 1 overload
                              <summary>
+ Static class that provides methods for formatting
+ and transforming Markdown documents.
+</summary>
                              
+
                              static member Markdown.Parse: text: string * ?newline: string * ?parseOptions: MarkdownParseOptions -> MarkdownDocument
                              
+
                              property MarkdownDocument.DefinedLinks: System.Collections.Generic.IDictionary<string,(string * string option)> with get
                              <summary>
+ Returns a dictionary containing explicitly defined links
+</summary>
                              
+
                              val par: MarkdownParagraph
                              
+
                              property MarkdownDocument.Paragraphs: MarkdownParagraphs with get
                              <summary>
+ Returns a list of paragraphs in the document
+</summary>
                              
+
                              union case MarkdownParagraph.Heading: size: int * body: MarkdownSpans * range: MarkdownRange option -> MarkdownParagraph
                              
+
                              Multiple items
                              union case MarkdownSpan.Literal: text: string * range: MarkdownRange option -> MarkdownSpan

                              --------------------
                              type LiteralAttribute =
+  inherit Attribute
+  new: unit -> LiteralAttribute

                              --------------------
                              new: unit -> LiteralAttribute
                              
+
                              val text: string
                              
+
                              val printfn: format: Printf.TextWriterFormat<'T> -> 'T
                              
+
                              val collectSpanLinks: span: MarkdownSpan -> string seq
                               Returns all links in a specified span node
                              
+
                              val span: MarkdownSpan
                              
+
                              Multiple items
                              val seq: sequence: 'T seq -> 'T seq

                              --------------------
                              type 'T seq = System.Collections.Generic.IEnumerable<'T>
                              
+
                              union case MarkdownSpan.DirectLink: body: MarkdownSpans * link: string * title: string option * range: MarkdownRange option -> MarkdownSpan
                              
+
                              val url: string
                              
+
                              union case MarkdownSpan.IndirectLink: body: MarkdownSpans * original: string * key: string * range: MarkdownRange option -> MarkdownSpan
                              
+
                              val key: string
                              
+
                              val fst: tuple: ('T1 * 'T2) -> 'T1
                              
+
                              module MarkdownPatterns
+
+from FSharp.Formatting.Markdown
                              <summary>
+ This module provides an easy way of processing Markdown documents.
+ It lets you decompose documents into leafs and nodes with nested paragraphs.
+</summary>
                              
+
                              Multiple items
                              val SpanLeaf: MarkdownPatterns.SpanLeafInfo -> MarkdownSpan

                              --------------------
                              active recognizer SpanLeaf: MarkdownSpan -> Choice<MarkdownPatterns.SpanLeafInfo,(MarkdownPatterns.SpanNodeInfo * MarkdownSpans)>
                              
+
                              Multiple items
                              val SpanNode: MarkdownPatterns.SpanNodeInfo * spans: MarkdownSpans -> MarkdownSpan

                              --------------------
                              active recognizer SpanNode: MarkdownSpan -> Choice<MarkdownPatterns.SpanLeafInfo,(MarkdownPatterns.SpanNodeInfo * MarkdownSpans)>
                              
+
                              val spans: MarkdownSpans
                              
+
                              val s: MarkdownSpan
                              
+
                              val collectParLinks: par: MarkdownParagraph -> string seq
                               Returns all links in the specified paragraph node
                              
+
                              Multiple items
                              val ParagraphLeaf: MarkdownPatterns.ParagraphLeafInfo -> MarkdownParagraph

                              --------------------
                              active recognizer ParagraphLeaf: MarkdownParagraph -> Choice<MarkdownPatterns.ParagraphLeafInfo,(MarkdownPatterns.ParagraphNestedInfo * MarkdownParagraphs list),(MarkdownPatterns.ParagraphSpansInfo * MarkdownSpans)>
                              
+
                              Multiple items
                              val ParagraphNested: MarkdownPatterns.ParagraphNestedInfo * pars: MarkdownParagraphs list -> MarkdownParagraph

                              --------------------
                              active recognizer ParagraphNested: MarkdownParagraph -> Choice<MarkdownPatterns.ParagraphLeafInfo,(MarkdownPatterns.ParagraphNestedInfo * MarkdownParagraphs list),(MarkdownPatterns.ParagraphSpansInfo * MarkdownSpans)>
                              
+
                              val pars: MarkdownParagraphs list
                              
+
                              val ps: MarkdownParagraphs
                              
+
                              val p: MarkdownParagraph
                              
+
                              Multiple items
                              val ParagraphSpans: MarkdownPatterns.ParagraphSpansInfo * spans: MarkdownSpans -> MarkdownParagraph

                              --------------------
                              active recognizer ParagraphSpans: MarkdownParagraph -> Choice<MarkdownPatterns.ParagraphLeafInfo,(MarkdownPatterns.ParagraphNestedInfo * MarkdownParagraphs list),(MarkdownPatterns.ParagraphSpansInfo * MarkdownSpans)>
                              
+
                              module Seq
+
+from Microsoft.FSharp.Collections
                              
+
                              val collect: mapping: ('T -> #('U seq)) -> source: 'T seq -> 'U seq
                              
+
                              val html: string
                              
+
                              static member Markdown.ToHtml: markdownText: string * ?newline: string * ?substitutions: (FSharp.Formatting.Templating.ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
                              static member Markdown.ToHtml: doc: MarkdownDocument * ?newline: string * ?substitutions: (FSharp.Formatting.Templating.ParamKey * string) list * ?crefResolver: (string -> (string * string) option) * ?mdlinkResolver: (string -> string option) -> string
                              
+
+    
                              
+
                              
+
+
+    
+    
                              
+        
                                
+        
                                Type something to start searching.
                                
+    
                                
+                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/markdown.ipynb b/markdown.ipynb
new file mode 100644
index 000000000..8dd93b187
--- /dev/null
+++ b/markdown.ipynb
@@ -0,0 +1,338 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "#r \"nuget: FSharp.Formatting,1.0.0\"\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=markdown.ipynb)\u0026emsp;\n",
+    "[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.fsx)\u0026emsp;\n",
+    "[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.ipynb)\n",
+    "\n",
+    "# Markdown parser\n",
+    "\n",
+    "This page demonstrates how to use `FSharp.Formatting.Markdown` to parse a Markdown\n",
+    "document, process the obtained document representation, and\n",
+    "how to turn the code into a nicely formatted HTML.\n",
+    "\n",
+    "First, we need to load the assembly and open the necessary namespaces:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "open FSharp.Formatting.Markdown\n",
+    "open FSharp.Formatting.Common\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "## Parsing documents\n",
+    "\n",
+    "The F# Markdown parser recognizes the standard [Markdown syntax](http://daringfireball.net/projects/markdown/)\n",
+    "and it is not the aim of this tutorial to fully document it.\n",
+    "The following snippet creates a simple string containing a document\n",
+    "with several elements and then parses it using the [Markdown.Parse](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#Parse) method:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let document =\n",
+    "    \"\"\"\n",
+    "# F# Hello world\n",
+    "Hello world in [F#](http://fsharp.net) looks like this:\n",
+    "\n",
+    "    printfn \"Hello world!\"\n",
+    "\n",
+    "For more see [fsharp.org][fsorg].\n",
+    "\n",
+    "  [fsorg]: http://fsharp.org \"The F# organization.\" \"\"\"\n",
+    "\n",
+    "let parsed = Markdown.Parse(document)\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The sample document consists of a first-level heading (written using\n",
+    "one of the two alternative styles) followed by a paragraph with a\n",
+    "**direct** link, code snippet and one more paragraph that includes an\n",
+    "**indirect** link. The URLs of indirect links are defined by a separate\n",
+    "block as demonstrated on the last line (and they can then be easily used repeatedly\n",
+    "from multiple places in the document).\n",
+    "\n",
+    "## Working with parsed documents\n",
+    "\n",
+    "The F# Markdown processor does not turn the document directly into HTML.\n",
+    "Instead, it builds a nice F# data structure that we can use to analyze,\n",
+    "transform and process the document. First of all the [MarkdownDocument.DefinedLinks](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#DefinedLinks) property\n",
+    "returns all indirect link definitions:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "parsed.DefinedLinks\n",
+    "// [fsi:val it : IDictionary\u003cstring,(string * string option)\u003e =]\n",
+    "// [fsi:  dict [(\"fsorg\", (\"http://fsharp.org\", Some \"The F# organization.\"))]]\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The document content can be accessed using the [MarkdownDocument.Paragraphs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#Paragraphs) property that returns\n",
+    "a sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).\n",
+    "The following snippet prints the heading of the document:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "// Iterate over all the paragraph elements\n",
+    "for par in parsed.Paragraphs do\n",
+    "    match par with\n",
+    "    | Heading (size = 1; body = [ Literal (text = text) ]) -\u003e\n",
+    "        // Recognize heading that has a simple content\n",
+    "        // containing just a literal (no other formatting)\n",
+    "        printfn \"%s\" text\n",
+    "    | _ -\u003e ()\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "You can find more detailed information about the document structure and how to process it\n",
+    "in the book [F# Deep Dives](http://manning.com/petricek2/).\n",
+    "\n",
+    "## Processing the document recursively\n",
+    "\n",
+    "The library provides active patterns that can be used to easily process the Markdown\n",
+    "document recursively. The example in this section shows how to extract all links from the\n",
+    "document. To do that, we need to write two recursive functions. One that will process\n",
+    "all paragraph-style elements and one that will process all inline formattings (inside\n",
+    "paragraphs, headings etc.).\n",
+    "\n",
+    "To avoid pattern matching on every single kind of span and every single kind of\n",
+    "paragraph, we can use active patterns from the [MarkdownPatterns](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html) module. These can be use\n",
+    "to recognize any paragraph or span that can contain child elements:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "/// Returns all links in a specified span node\n",
+    "let rec collectSpanLinks span =\n",
+    "    seq {\n",
+    "        match span with\n",
+    "        | DirectLink (link = url) -\u003e yield url\n",
+    "        | IndirectLink (key = key) -\u003e yield fst (parsed.DefinedLinks.[key])\n",
+    "        | MarkdownPatterns.SpanLeaf _ -\u003e ()\n",
+    "        | MarkdownPatterns.SpanNode (_, spans) -\u003e\n",
+    "            for s in spans do\n",
+    "                yield! collectSpanLinks s\n",
+    "    }\n",
+    "\n",
+    "/// Returns all links in the specified paragraph node\n",
+    "let rec collectParLinks par =\n",
+    "    seq {\n",
+    "        match par with\n",
+    "        | MarkdownPatterns.ParagraphLeaf _ -\u003e ()\n",
+    "        | MarkdownPatterns.ParagraphNested (_, pars) -\u003e\n",
+    "            for ps in pars do\n",
+    "                for p in ps do\n",
+    "                    yield! collectParLinks p\n",
+    "        | MarkdownPatterns.ParagraphSpans (_, spans) -\u003e\n",
+    "            for s in spans do\n",
+    "                yield! collectSpanLinks s\n",
+    "    }\n",
+    "\n",
+    "// Collect links in the entire document\n",
+    "Seq.collect collectParLinks parsed.Paragraphs\n",
+    "// [fsi:val it : seq\u003cstring\u003e =]\n",
+    "// [fsi:  seq [\"http://fsharp.net\"; \"http://fsharp.org\"]]\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The `collectSpanLinks` function works on individual span elements that contain inline\n",
+    "formatting (emphasis, strong) and also links. The `DirectLink` node from [MarkdownSpan](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html) represents an inline\n",
+    "link like the one pointing to [http://fsharp.net](http://fsharp.net) while `IndirectLink` represents a\n",
+    "link that uses one of the link definitions. The function simply returns the URL associated\n",
+    "with the link.\n",
+    "\n",
+    "Some span nodes (like emphasis) can contain other formatting, so we need to recursively\n",
+    "process children. This is done by matching against `MarkdownPatterns.SpanNodes` which is an active\n",
+    "pattern that recognizes any node with children. The library also provides a **function**\n",
+    "named `MarkdownPatterns.SpanNode` that can be used to reconstruct the same node (when you want\n",
+    "to transform a document). This is similar to how the `ExprShape` module for working with\n",
+    "F# quotations works.\n",
+    "\n",
+    "The function `collectParLinks` processes paragraphs - a paragraph cannot directly be a\n",
+    "link so we just need to process all spans. This time, there are three options.\n",
+    "`ParagraphLeaf` represents a case where the paragraph does not contain any spans\n",
+    "(a code block or, for example, a `\u003chr\u003e` line); the `ParagraphNested` case is used for paragraphs\n",
+    "that contain other paragraphs (quotation) and `ParagraphSpans` is used for all other\n",
+    "paragraphs that contain normal text - here we call `collectSpanLinks` on all nested spans.\n",
+    "\n",
+    "## Generating HTML output\n",
+    "\n",
+    "Finally, the [Markdown](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html) type also includes a method [Markdown.ToHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToHtml) that can be used\n",
+    "to generate an HTML document from the Markdown input. The following example shows how to call it:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let html = Markdown.ToHtml(parsed)\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "There are also methods to generate `.fsx`, `.ipynb`, `.md` and `.tex`.\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/markdown.md b/markdown.md
new file mode 100644
index 000000000..cedb79ce0
--- /dev/null
+++ b/markdown.md
@@ -0,0 +1,154 @@
+[![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=markdown.ipynb) 
+[![Script](img/badge-script.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.fsx) 
+[![Notebook](img/badge-notebook.svg)](https://fsprojects.github.io/FSharp.Formatting//markdown.ipynb)
+
+# Markdown parser
+
+This page demonstrates how to use `FSharp.Formatting.Markdown` to parse a Markdown
+document, process the obtained document representation, and
+how to turn the code into a nicely formatted HTML.
+
+First, we need to load the assembly and open the necessary namespaces:
+
+```fsharp
+open FSharp.Formatting.Markdown
+open FSharp.Formatting.Common
+```
+
+## Parsing documents
+
+The F# Markdown parser recognizes the standard [Markdown syntax](http://daringfireball.net/projects/markdown/)
+and it is not the aim of this tutorial to fully document it.
+The following snippet creates a simple string containing a document
+with several elements and then parses it using the [Markdown.Parse](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#Parse) method:
+
+```fsharp
+let document =
+    """
+# F# Hello world
+Hello world in [F#](http://fsharp.net) looks like this:
+
+    printfn "Hello world!"
+
+For more see [fsharp.org][fsorg].
+
+  [fsorg]: http://fsharp.org "The F# organization." """
+
+let parsed = Markdown.Parse(document)
+```
+
+The sample document consists of a first-level heading (written using
+one of the two alternative styles) followed by a paragraph with a
+**direct** link, code snippet and one more paragraph that includes an
+**indirect** link. The URLs of indirect links are defined by a separate
+block as demonstrated on the last line (and they can then be easily used repeatedly
+from multiple places in the document).
+
+## Working with parsed documents
+
+The F# Markdown processor does not turn the document directly into HTML.
+Instead, it builds a nice F# data structure that we can use to analyze,
+transform and process the document. First of all the [MarkdownDocument.DefinedLinks](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#DefinedLinks) property
+returns all indirect link definitions:
+
+```fsharp
+parsed.DefinedLinks
+// [fsi:val it : IDictionary =]
+// [fsi:  dict [("fsorg", ("http://fsharp.org", Some "The F# organization."))]]
+```
+
+The document content can be accessed using the [MarkdownDocument.Paragraphs](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html#Paragraphs) property that returns
+a sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).
+The following snippet prints the heading of the document:
+
+```fsharp
+// Iterate over all the paragraph elements
+for par in parsed.Paragraphs do
+    match par with
+    | Heading (size = 1; body = [ Literal (text = text) ]) ->
+        // Recognize heading that has a simple content
+        // containing just a literal (no other formatting)
+        printfn "%s" text
+    | _ -> ()
+```
+
+You can find more detailed information about the document structure and how to process it
+in the book [F# Deep Dives](http://manning.com/petricek2/).
+
+## Processing the document recursively
+
+The library provides active patterns that can be used to easily process the Markdown
+document recursively. The example in this section shows how to extract all links from the
+document. To do that, we need to write two recursive functions. One that will process
+all paragraph-style elements and one that will process all inline formattings (inside
+paragraphs, headings etc.).
+
+To avoid pattern matching on every single kind of span and every single kind of
+paragraph, we can use active patterns from the [MarkdownPatterns](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html) module. These can be use
+to recognize any paragraph or span that can contain child elements:
+
+```fsharp
+/// Returns all links in a specified span node
+let rec collectSpanLinks span =
+    seq {
+        match span with
+        | DirectLink (link = url) -> yield url
+        | IndirectLink (key = key) -> yield fst (parsed.DefinedLinks.[key])
+        | MarkdownPatterns.SpanLeaf _ -> ()
+        | MarkdownPatterns.SpanNode (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+/// Returns all links in the specified paragraph node
+let rec collectParLinks par =
+    seq {
+        match par with
+        | MarkdownPatterns.ParagraphLeaf _ -> ()
+        | MarkdownPatterns.ParagraphNested (_, pars) ->
+            for ps in pars do
+                for p in ps do
+                    yield! collectParLinks p
+        | MarkdownPatterns.ParagraphSpans (_, spans) ->
+            for s in spans do
+                yield! collectSpanLinks s
+    }
+
+// Collect links in the entire document
+Seq.collect collectParLinks parsed.Paragraphs
+// [fsi:val it : seq =]
+// [fsi:  seq ["http://fsharp.net"; "http://fsharp.org"]]
+```
+
+The `collectSpanLinks` function works on individual span elements that contain inline
+formatting (emphasis, strong) and also links. The `DirectLink` node from [MarkdownSpan](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html) represents an inline
+link like the one pointing to [http://fsharp.net](http://fsharp.net) while `IndirectLink` represents a
+link that uses one of the link definitions. The function simply returns the URL associated
+with the link.
+
+Some span nodes (like emphasis) can contain other formatting, so we need to recursively
+process children. This is done by matching against `MarkdownPatterns.SpanNodes` which is an active
+pattern that recognizes any node with children. The library also provides a **function**
+named `MarkdownPatterns.SpanNode` that can be used to reconstruct the same node (when you want
+to transform a document). This is similar to how the `ExprShape` module for working with
+F# quotations works.
+
+The function `collectParLinks` processes paragraphs - a paragraph cannot directly be a
+link so we just need to process all spans. This time, there are three options.
+`ParagraphLeaf` represents a case where the paragraph does not contain any spans
+(a code block or, for example, a `
                                ` line); the `ParagraphNested` case is used for paragraphs
+that contain other paragraphs (quotation) and `ParagraphSpans` is used for all other
+paragraphs that contain normal text - here we call `collectSpanLinks` on all nested spans.
+
+## Generating HTML output
+
+Finally, the [Markdown](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html) type also includes a method [Markdown.ToHtml](https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html#ToHtml) that can be used
+to generate an HTML document from the Markdown input. The following example shows how to call it:
+
+```fsharp
+let html = Markdown.ToHtml(parsed)
+```
+
+There are also methods to generate `.fsx`, `.ipynb`, `.md` and `.tex`.
+
+
diff --git a/markdown.tex b/markdown.tex
new file mode 100644
index 000000000..95484c736
--- /dev/null
+++ b/markdown.tex
@@ -0,0 +1,247 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+
+
+\href{https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath=markdown.ipynb}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-binder.svg}
+\caption{Binder}
+\end{figure}
+} 
+\href{https://fsprojects.github.io/FSharp.Formatting//markdown.fsx}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-script.svg}
+\caption{Script}
+\end{figure}
+} 
+\href{https://fsprojects.github.io/FSharp.Formatting//markdown.ipynb}{\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{img/badge-notebook.svg}
+\caption{Notebook}
+\end{figure}
+}
+\section*{Markdown parser}
+
+
+
+This page demonstrates how to use \texttt{FSharp.Formatting.Markdown} to parse a Markdown
+document, process the obtained document representation, and
+how to turn the code into a nicely formatted HTML.
+
+
+First, we need to load the assembly and open the necessary namespaces:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Markdown}
+\kwd{open} \id{FSharp}{.}\id{Formatting}{.}\id{Common}
+
+\end{lstlisting}
+
+\subsection*{Parsing documents}
+
+
+
+The F\# Markdown parser recognizes the standard \href{http://daringfireball.net/projects/markdown/}{Markdown syntax}
+and it is not the aim of this tutorial to fully document it.
+The following snippet creates a simple string containing a document
+with several elements and then parses it using the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html\#Parse}{Markdown.Parse} method:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{document} \ops{=}
+    \str{"""}
+\str{\# F\# Hello world}
+\str{Hello world in [F\#](http://fsharp.net) looks like this:}
+
+\str{    printfn "Hello world!"}
+
+\str{For more see [fsharp.org][fsorg].}
+
+\str{  [fsorg]: http://fsharp.org "The F\# organization." """}
+
+\kwd{let} \id{parsed} \ops{=} \ltyp{Markdown}{.}\id{Parse}{(}\id{document}{)}
+
+\end{lstlisting}
+
+
+
+The sample document consists of a first-level heading (written using
+one of the two alternative styles) followed by a paragraph with a
+\emph{direct} link, code snippet and one more paragraph that includes an
+\emph{indirect} link. The URLs of indirect links are defined by a separate
+block as demonstrated on the last line (and they can then be easily used repeatedly
+from multiple places in the document).
+\subsection*{Working with parsed documents}
+
+
+
+The F\# Markdown processor does not turn the document directly into HTML.
+Instead, it builds a nice F\# data structure that we can use to analyze,
+transform and process the document. First of all the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html\#DefinedLinks}{MarkdownDocument.DefinedLinks} property
+returns all indirect link definitions:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\id{parsed}{.}\id{DefinedLinks}
+\fsi{val it : IDictionary =}
+\fsi{  dict [("fsorg", ("http://fsharp.org", Some "The F\# organization."))]}
+
+\end{lstlisting}
+
+
+
+The document content can be accessed using the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdowndocument.html\#Paragraphs}{MarkdownDocument.Paragraphs} property that returns
+a sequence of paragraphs or other first-level elements (headings, quotes, code snippets, etc.).
+The following snippet prints the heading of the document:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{// Iterate over all the paragraph elements}
+\kwd{for} \lfun{par} \kwd{in} \id{parsed}{.}\id{Paragraphs} \kwd{do}
+    \kwd{match} \lfun{par} \kwd{with}
+    {|} {Heading} {(}{size} \ops{=} \num{1}{;} {body} \ops{=} {[} {Literal} {(}{text} \ops{=} \lfun{text}{)} {]}{)} \kwd{->}
+        \com{// Recognize heading that has a simple content}
+        \com{// containing just a literal (no other formatting)}
+        \lfun{printfn} \str{"}\lprf{\%s}\str{"} \lfun{text}
+    {|} \id{\_} \kwd{->} {(}{)}
+
+\end{lstlisting}
+
+
+
+You can find more detailed information about the document structure and how to process it
+in the book \href{http://manning.com/petricek2/}{F\# Deep Dives}.
+\subsection*{Processing the document recursively}
+
+
+
+The library provides active patterns that can be used to easily process the Markdown
+document recursively. The example in this section shows how to extract all links from the
+document. To do that, we need to write two recursive functions. One that will process
+all paragraph-style elements and one that will process all inline formattings (inside
+paragraphs, headings etc.).
+
+
+To avoid pattern matching on every single kind of span and every single kind of
+paragraph, we can use active patterns from the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownpatterns.html}{MarkdownPatterns} module. These can be use
+to recognize any paragraph or span that can contain child elements:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{/// Returns all links in a specified span node}
+\kwd{let} \kwd{rec} \lfun{collectSpanLinks} \lfun{span} \ops{=}
+    \lfun{seq} {\{}
+        \kwd{match} \lfun{span} \kwd{with}
+        {|} {DirectLink} {(}{link} \ops{=} \lfun{url}{)} \kwd{->} \kwd{yield} \lfun{url}
+        {|} {IndirectLink} {(}{key} \ops{=} \lfun{key}{)} \kwd{->} \kwd{yield} \lfun{fst} {(}\id{parsed}{.}\id{DefinedLinks}{.}{[}\lfun{key}{]}{)}
+        {|} \ltyp{MarkdownPatterns}{.}\id{SpanLeaf} \id{\_} \kwd{->} {(}{)}
+        {|} \ltyp{MarkdownPatterns}{.}\id{SpanNode} {(}\id{\_}{,} \lfun{spans}{)} \kwd{->}
+            \kwd{for} \lfun{s} \kwd{in} \lfun{spans} \kwd{do}
+                \kwd{yield!} \lfun{collectSpanLinks} \lfun{s}
+    {\}}
+
+\com{/// Returns all links in the specified paragraph node}
+\kwd{let} \kwd{rec} \lfun{collectParLinks} \lfun{par} \ops{=}
+    \lfun{seq} {\{}
+        \kwd{match} \lfun{par} \kwd{with}
+        {|} \ltyp{MarkdownPatterns}{.}\id{ParagraphLeaf} \id{\_} \kwd{->} {(}{)}
+        {|} \ltyp{MarkdownPatterns}{.}\id{ParagraphNested} {(}\id{\_}{,} \lfun{pars}{)} \kwd{->}
+            \kwd{for} \lfun{ps} \kwd{in} \lfun{pars} \kwd{do}
+                \kwd{for} \lfun{p} \kwd{in} \lfun{ps} \kwd{do}
+                    \kwd{yield!} \lfun{collectParLinks} \lfun{p}
+        {|} \ltyp{MarkdownPatterns}{.}\id{ParagraphSpans} {(}\id{\_}{,} \lfun{spans}{)} \kwd{->}
+            \kwd{for} \lfun{s} \kwd{in} \lfun{spans} \kwd{do}
+                \kwd{yield!} \lfun{collectSpanLinks} \lfun{s}
+    {\}}
+
+\com{// Collect links in the entire document}
+\ltyp{Seq}{.}\id{collect} \lfun{collectParLinks} \id{parsed}{.}\id{Paragraphs}
+\fsi{val it : seq =}
+\fsi{  seq ["http://fsharp.net"; "http://fsharp.org"]}
+
+\end{lstlisting}
+
+
+
+The \texttt{collectSpanLinks} function works on individual span elements that contain inline
+formatting (emphasis, strong) and also links. The \texttt{DirectLink} node from \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdownspan.html}{MarkdownSpan} represents an inline
+link like the one pointing to \href{http://fsharp.net}{http://fsharp.net} while \texttt{IndirectLink} represents a
+link that uses one of the link definitions. The function simply returns the URL associated
+with the link.
+
+
+Some span nodes (like emphasis) can contain other formatting, so we need to recursively
+process children. This is done by matching against \texttt{MarkdownPatterns.SpanNodes} which is an active
+pattern that recognizes any node with children. The library also provides a \emph{function}
+named \texttt{MarkdownPatterns.SpanNode} that can be used to reconstruct the same node (when you want
+to transform a document). This is similar to how the \texttt{ExprShape} module for working with
+F\# quotations works.
+
+
+The function \texttt{collectParLinks} processes paragraphs - a paragraph cannot directly be a
+link so we just need to process all spans. This time, there are three options.
+\texttt{ParagraphLeaf} represents a case where the paragraph does not contain any spans
+(a code block or, for example, a \texttt{
                                } line); the \texttt{ParagraphNested} case is used for paragraphs
+that contain other paragraphs (quotation) and \texttt{ParagraphSpans} is used for all other
+paragraphs that contain normal text - here we call \texttt{collectSpanLinks} on all nested spans.
+\subsection*{Generating HTML output}
+
+
+
+Finally, the \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html}{Markdown} type also includes a method \href{https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-markdown-markdown.html\#ToHtml}{Markdown.ToHtml} that can be used
+to generate an HTML document from the Markdown input. The following example shows how to call it:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{html} \ops{=} \ltyp{Markdown}{.}\id{ToHtml}{(}\id{parsed}{)}
+
+\end{lstlisting}
+
+
+
+There are also methods to generate \texttt{.fsx}, \texttt{.ipynb}, \texttt{.md} and \texttt{.tex}.
+
+
+\end{document}
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocattribute.html b/reference/fsharp-formatting-apidocs-apidocattribute.html
new file mode 100644
index 000000000..4b8115b5a
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocattribute.html
@@ -0,0 +1,1298 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocAttribute (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                
+    
                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                
+    
                                
+        
+            
+        
+        
+        
+    
                                
+
                                
+
+
                                
+    
                                
+        
                                
+  
                                
+    ApiDocAttribute Type
+  
                                
+  
                                
+    
                                
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                
+    
                                
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                
+    
                                
+      Base Type: 
+      obj
+    
                                
+  
                                
+  
                                
+    
                                
+      
                                
+        
                                
+           Represents a custom attribute attached to source code
+        
                                
+      
                                
+    
                                
+  
                                
+  
                                
+  
                                
+  
                                
+  
                                
+  
                                
+  
                                
+  
                                
+    
                                
+      Constructors
+    
                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                
+            Constructor
+          
+            Description
+            
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  ApiDocAttribute(name, fullName, constructorArguments, namedConstructorArguments)
+                  
                                
+                  
                                
+                  Parameters: 
+                  
                                  
+                    
+                      
+                        name
+                      
+                      :
+                      string
+                    
+                    
                                  
+                    
+                      
+                        fullName
+                      
+                      :
+                      string
+                    
+                    
                                  
+                    
+                      
+                        constructorArguments
+                      
+                      :
+                      obj list
+                    
+                    
                                  
+                    
+                      
+                        namedConstructorArguments
+                      
+                      :
+                      (string * obj) list
+                    
+                    
                                  
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    ApiDocAttribute
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
                                
+                
+                  
+                
+              
                                
+              
                                
+                
                                
+                  
+                    name
+                  
+                  :
+                  string
+                
                                
+                
                                
+                
                                
+                  
+                    fullName
+                  
+                  :
+                  string
+                
                                
+                
                                
+                
                                
+                  
+                    constructorArguments
+                  
+                  :
+                  obj list
+                
                                
+                
                                
+                
                                
+                  
+                    namedConstructorArguments
+                  
+                  :
+                  (string * obj) list
+                
                                
+                
                                
+              
                                
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  ApiDocAttribute
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+  
                                
+  
                                
+    
                                
+      Instance members
+    
                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                
+            Instance member
+          
+            Description
+            
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.ConstructorArguments
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.ConstructorArguments
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    obj list
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       The arguments to the constructor for the attribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  obj list
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.CustomOperationName
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.CustomOperationName
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Returns the custom operation name, when this attribute is the CustomOperationAttribute. When its not an empty string is returned
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.Format
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.Format
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Formats the attribute using the Name. Removes the "Attribute"-suffix. E.g Obsolete
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.FormatFullName
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.FormatFullName
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Formats the attribute using the FullName. Removes the "Attribute"-suffix. E.g System.Obsolete
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.FormatFullNameLongForm
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.FormatFullNameLongForm
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Formats the attribute using the FullName. Keeps the "Attribute"-suffix. E.g System.ObsoleteAttribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.FormatLongForm
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.FormatLongForm
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Formats the attribute using the Name. Keeps the "Attribute"-suffix. E.g ObsoleteAttribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.FullName
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.FullName
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       The qualified name of the attribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.IsCustomOperationAttribute
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.IsCustomOperationAttribute
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Gets a value indicating whether this attribute the CustomOperationAttribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.IsObsoleteAttribute
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.IsObsoleteAttribute
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Gets a value indicating whether this attribute is System.ObsoleteAttribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.IsRequireQualifiedAccessAttribute
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.IsRequireQualifiedAccessAttribute
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Gets a value indicating whether this attribute is RequireQualifiedAccessAttribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.Name
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.Name
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       The name of the attribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.NamedConstructorArguments
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.NamedConstructorArguments
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    (string * obj) list
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       The named arguments for the attribute
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  (string * obj) list
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+            
                                
+              
+                
                                
+                  
+                    
+                      this.ObsoleteMessage
+                    
+                  
+                
                                
+                                              
+              
                                
+                
                                
+                  Full Usage: 
+                  this.ObsoleteMessage
+                  
                                
+                  
                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                
+                
                                
+              
                                
+            
                                
+                                          		
+            
                                
+              
+                
                                
+                  
                                
+                    
                                
+                       Returns the obsolete message, when this attribute is the System.ObsoleteAttribute. When its not or no message was specified, an empty string is returned
+                    
                                
+                  
                                
+                  
                                
+                    
+                      
+                    
+                    
                                
+                      
+                    
                                
+                    
                                
+                      
+                    
                                
+                  
                                
+                
                                
+                                              
+              
                                
+                
                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                
+                
                                
+              
                                
+            
                                
+          
                                
+  
                                
+  
                                
+
                                
+        
+    
                                
+
                                
+
+
+    
+    
                                
+        
                                  
+        
                                  Type something to start searching.
                                  
+    
                                  
+                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidoccollection.html b/reference/fsharp-formatting-apidocs-apidoccollection.html
new file mode 100644
index 000000000..5b1143c22
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidoccollection.html
@@ -0,0 +1,672 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocCollection (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                  
+    
                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                  
+    
                                  
+        
+            
+        
+        
+        
+    
                                  
+
                                  
+
+
                                  
+    
                                  
+        
                                  
+  
                                  
+    ApiDocCollection Type
+  
                                  
+  
                                  
+    
                                  
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                  
+    
                                  
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                  
+    
                                  
+      Base Type: 
+      obj
+    
                                  
+  
                                  
+  
                                  
+    
                                  
+      
                                  
+        
                                  
+           Represents a group of assemblies integrated with its associated documentation
+        
                                  
+      
                                  
+    
                                  
+  
                                  
+  
                                  
+  
                                  
+  
                                  
+  
                                  
+  
                                  
+  
                                  
+  
                                  
+    
                                  
+      Constructors
+    
                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                  
+            Constructor
+          
+            Description
+            
+          
                                  
+            
                                  
+              
+                
                                  
+                  
+                    
+                      ApiDocCollection(name, asms, nss)
+                    
+                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  Full Usage: 
+                  ApiDocCollection(name, asms, nss)
+                  
                                  
+                  
                                  
+                  Parameters: 
+                  
+                  
                                  
+                  
+                    Returns: 
+                    ApiDocCollection
+                  
+                  
                                  
+                
                                  
+              
                                  
+            
                                  
+                                            		
+            
                                  
+              
                                  
+                
+                  
+                
+              
                                  
+              
                                  
+                
                                  
+                  
+                    name
+                  
+                  :
+                  string
+                
                                  
+                
                                  
+                
                                  
+                  
+                    asms
+                  
+                  :
+                  AssemblyName list
+                
                                  
+                
                                  
+                
                                  
+                  
+                    nss
+                  
+                  :
+                  ApiDocNamespace list
+                
                                  
+                
                                  
+              
                                  
+              
                                  
+                
                                  
+                  
+                    Returns: 
+                  
+                  ApiDocCollection
+                
                                  
+                
                                  
+              
                                  
+            
                                  
+          
                                  
+  
                                  
+  
                                  
+    
                                  
+      Instance members
+    
                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                  
+            Instance member
+          
+            Description
+            
+          
                                  
+            
                                  
+              
+                
                                  
+                  
+                    
+                      this.Assemblies
+                    
+                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  Full Usage: 
+                  this.Assemblies
+                  
                                  
+                  
                                  
+                  
+                    Returns: 
+                    AssemblyName list
+                  
+                  
                                  
+                
                                  
+              
                                  
+            
                                  
+                                            		
+            
                                  
+              
+                
                                  
+                  
                                  
+                    
                                  
+                       All assemblies in the collection
+                    
                                  
+                  
                                  
+                  
                                  
+                    
+                      
+                    
+                    
                                  
+                      
+                    
                                  
+                    
                                  
+                      
+                    
                                  
+                  
                                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  
+                    Returns: 
+                  
+                  AssemblyName list
+                
                                  
+                
                                  
+              
                                  
+            
                                  
+          
                                  
+            
                                  
+              
+                
                                  
+                  
+                    
+                      this.CollectionName
+                    
+                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  Full Usage: 
+                  this.CollectionName
+                  
                                  
+                  
                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                  
+                
                                  
+              
                                  
+            
                                  
+                                            		
+            
                                  
+              
+                
                                  
+                  
                                  
+                    
                                  
+                       Name of the collection
+                    
                                  
+                  
                                  
+                  
                                  
+                    
+                      
+                    
+                    
                                  
+                      
+                    
                                  
+                    
                                  
+                      
+                    
                                  
+                  
                                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                  
+                
                                  
+              
                                  
+            
                                  
+          
                                  
+            
                                  
+              
+                
                                  
+                  
+                    
+                      this.Namespaces
+                    
+                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  Full Usage: 
+                  this.Namespaces
+                  
                                  
+                  
                                  
+                  
+                    Returns: 
+                    ApiDocNamespace list
+                  
+                  
                                  
+                
                                  
+              
                                  
+            
                                  
+                                            		
+            
                                  
+              
+                
                                  
+                  
                                  
+                    
                                  
+                       All namespaces in the collection
+                    
                                  
+                  
                                  
+                  
                                  
+                    
+                      
+                    
+                    
                                  
+                      
+                    
                                  
+                    
                                  
+                      
+                    
                                  
+                  
                                  
+                
                                  
+                                                
+              
                                  
+                
                                  
+                  
+                    Returns: 
+                  
+                  ApiDocNamespace list
+                
                                  
+                
                                  
+              
                                  
+            
                                  
+          
                                  
+  
                                  
+  
                                  
+
                                  
+        
+    
                                  
+
                                  
+
+
+    
+    
                                  
+        
                                    
+        
                                    Type something to start searching.
                                    
+    
                                    
+                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidoccomment.html b/reference/fsharp-formatting-apidocs-apidoccomment.html
new file mode 100644
index 000000000..11307a1ce
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidoccomment.html
@@ -0,0 +1,1134 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocComment (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                    
+    
                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                    
+    
                                    
+        
+            
+        
+        
+        
+    
                                    
+
                                    
+
+
                                    
+    
                                    
+        
                                    
+  
                                    
+    ApiDocComment Type
+  
                                    
+  
                                    
+    
                                    
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                    
+    
                                    
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                    
+    
                                    
+      Base Type: 
+      obj
+    
                                    
+  
                                    
+  
                                    
+    
                                    
+      
                                    
+        
                                    
+           Represents a documentation comment attached to source code
+        
                                    
+      
                                    
+    
                                    
+  
                                    
+  
                                    
+  
                                    
+  
                                    
+  
                                    
+  
                                    
+  
                                    
+  
                                    
+    
                                    
+      Constructors
+    
                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                    
+            Constructor
+          
+            Description
+            
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, rawData)
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, rawData)
+                  
                                    
+                  
                                    
+                  Parameters: 
+                  
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocComment
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
                                    
+                
+                  
+                
+              
                                    
+              
                                    
+                
                                    
+                  
+                    xmldoc
+                  
+                  :
+                  XElement option
+                
                                    
+                
                                    
+                
                                    
+                  
+                    summary
+                  
+                  :
+                  ApiDocHtml
+                
                                    
+                
                                    
+                
                                    
+                  
+                    remarks
+                  
+                  :
+                  ApiDocHtml option
+                
                                    
+                
                                    
+                
                                    
+                  
+                    parameters
+                  
+                  :
+                  (string * ApiDocHtml) list
+                
                                    
+                
                                    
+                
                                    
+                  
+                    returns
+                  
+                  :
+                  ApiDocHtml option
+                
                                    
+                
                                    
+                
                                    
+                  
+                    examples
+                  
+                  :
+                  ApiDocHtml list
+                
                                    
+                
                                    
+                
                                    
+                  
+                    notes
+                  
+                  :
+                  ApiDocHtml list
+                
                                    
+                
                                    
+                
                                    
+                  
+                    exceptions
+                  
+                  :
+                  (string * string option * ApiDocHtml) list
+                
                                    
+                
                                    
+                
                                    
+                  
+                    rawData
+                  
+                  :
+                  KeyValuePair<string, string> list
+                
                                    
+                
                                    
+              
                                    
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocComment
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+  
                                    
+  
                                    
+    
                                    
+      Instance members
+    
                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                    
+            Instance member
+          
+            Description
+            
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Examples
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Examples
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocHtml list
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The examples sections of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocHtml list
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Exceptions
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Exceptions
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    (string * string option * ApiDocHtml) list
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The notes sections of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  (string * string option * ApiDocHtml) list
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Notes
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Notes
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocHtml list
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The notes sections of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocHtml list
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Parameters
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Parameters
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    (string * ApiDocHtml) list
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The param sections of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  (string * ApiDocHtml) list
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.RawData
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.RawData
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    KeyValuePair<string, string> list
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The raw data of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  KeyValuePair<string, string> list
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Remarks
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Remarks
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocHtml option
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The remarks html for comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocHtml option
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Returns
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Returns
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocHtml option
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The return sections of the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocHtml option
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Summary
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Summary
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    ApiDocHtml
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The summary for the comment
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  ApiDocHtml
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+            
                                    
+              
+                
                                    
+                  
+                    
+                      this.Xml
+                    
+                  
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  Full Usage: 
+                  this.Xml
+                  
                                    
+                  
                                    
+                  
+                    Returns: 
+                    XElement option
+                  
+                  
                                    
+                
                                    
+              
                                    
+            
                                    
+                                              		
+            
                                    
+              
+                
                                    
+                  
                                    
+                    
                                    
+                       The XElement for the XML doc if available
+                    
                                    
+                  
                                    
+                  
                                    
+                    
+                      
+                    
+                    
                                    
+                      
+                    
                                    
+                    
                                    
+                      
+                    
                                    
+                  
                                    
+                
                                    
+                                                  
+              
                                    
+                
                                    
+                  
+                    Returns: 
+                  
+                  XElement option
+                
                                    
+                
                                    
+              
                                    
+            
                                    
+          
                                    
+  
                                    
+  
                                    
+
                                    
+        
+    
                                    
+
                                    
+
+
+    
+    
                                    
+        
                                      
+        
                                      Type something to start searching.
                                      
+    
                                      
+                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocentity.html b/reference/fsharp-formatting-apidocs-apidocentity.html
new file mode 100644
index 000000000..fdbeceda2
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocentity.html
@@ -0,0 +1,3115 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocEntity (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                      
+    
                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                      
+    
                                      
+        
+            
+        
+        
+        
+    
                                      
+
                                      
+
+
                                      
+    
                                      
+        
                                      
+  
                                      
+    ApiDocEntity Type
+  
                                      
+  
                                      
+    
                                      
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                      
+    
                                      
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                      
+    
                                      
+      Base Type: 
+      obj
+    
                                      
+  
                                      
+  
                                      
+    
                                      
+      
                                      
+        
                                      
+           Represents a type definition integrated with its associated documentation
+        
                                      
+      
                                      
+    
                                      
+  
                                      
+  
                                      
+  
                                      
+  
                                      
+  
                                      
+  
                                      
+  
                                      
+  
                                      
+    
                                      
+      Constructors
+    
                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                      
+            Constructor
+          
+            Description
+            
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      ApiDocEntity(tdef, name, cat, catidx, exclude, urlBaseName, comment, assembly, attributes, cases, fields, statParams, ctors, inst, stat, allInterfaces, baseType, abbreviatedType, delegateSignature, symbol, nested, vals, exts, pats, rqa, location, substitutions)
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  ApiDocEntity(tdef, name, cat, catidx, exclude, urlBaseName, comment, assembly, attributes, cases, fields, statParams, ctors, inst, stat, allInterfaces, baseType, abbreviatedType, delegateSignature, symbol, nested, vals, exts, pats, rqa, location, substitutions)
+                  
                                      
+                  
                                      
+                  Parameters: 
+                  
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocEntity
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
                                      
+                
+                  
+                
+              
                                      
+              
                                      
+                
                                      
+                  
+                    tdef
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    name
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    cat
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    catidx
+                  
+                  :
+                  int
+                
                                      
+                
                                      
+                
                                      
+                  
+                    exclude
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    urlBaseName
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    comment
+                  
+                  :
+                  ApiDocComment
+                
                                      
+                
                                      
+                
                                      
+                  
+                    assembly
+                  
+                  :
+                  AssemblyName
+                
                                      
+                
                                      
+                
                                      
+                  
+                    attributes
+                  
+                  :
+                  ApiDocAttribute list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    cases
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    fields
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    statParams
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    ctors
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    inst
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    stat
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    allInterfaces
+                  
+                  :
+                  (FSharpType * ApiDocHtml) list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    baseType
+                  
+                  :
+                  (FSharpType * ApiDocHtml) option
+                
                                      
+                
                                      
+                
                                      
+                  
+                    abbreviatedType
+                  
+                  :
+                  (FSharpType * ApiDocHtml) option
+                
                                      
+                
                                      
+                
                                      
+                  
+                    delegateSignature
+                  
+                  :
+                  (FSharpDelegateSignature * ApiDocHtml) option
+                
                                      
+                
                                      
+                
                                      
+                  
+                    symbol
+                  
+                  :
+                  FSharpEntity
+                
                                      
+                
                                      
+                
                                      
+                  
+                    nested
+                  
+                  :
+                  ApiDocEntity list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    vals
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    exts
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    pats
+                  
+                  :
+                  ApiDocMember list
+                
                                      
+                
                                      
+                
                                      
+                  
+                    rqa
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    location
+                  
+                  :
+                  string option
+                
                                      
+                
                                      
+                
                                      
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                      
+                
                                      
+              
                                      
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocEntity
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+  
                                      
+  
                                      
+    
                                      
+      Instance members
+    
                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                      
+            Instance member
+          
+            Description
+            
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.AbbreviatedType
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.AbbreviatedType
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    (FSharpType * ApiDocHtml) option
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       If this is a type abbreviation, then the abbreviated type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  (FSharpType * ApiDocHtml) option
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.ActivePatterns
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.ActivePatterns
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Active patterns of the module
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.AllInterfaces
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.AllInterfaces
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    (FSharpType * ApiDocHtml) list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       All interfaces of the type, formatted
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  (FSharpType * ApiDocHtml) list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.AllMembers
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.AllMembers
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       All members of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Assembly
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Assembly
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    AssemblyName
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The name of the type's assembly
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  AssemblyName
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Attributes
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Attributes
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocAttribute list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The declared attributes of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocAttribute list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.BaseType
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.BaseType
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    (FSharpType * ApiDocHtml) option
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The base type of the type, formatted
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  (FSharpType * ApiDocHtml) option
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Category
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Category
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The category of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.CategoryIndex
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.CategoryIndex
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    int
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The category index of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  int
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Comment
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Comment
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocComment
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The attached comment
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocComment
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Constructors
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Constructors
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The constuctorsof the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.DelegateSignature
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.DelegateSignature
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    (FSharpDelegateSignature * ApiDocHtml) option
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       If this is a delegate, then e formatted signature
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  (FSharpDelegateSignature * ApiDocHtml) option
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Exclude
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Exclude
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The exclude flag
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.InstanceMembers
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.InstanceMembers
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The instance members of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.IsObsolete
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.IsObsolete
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Gets a value indicating whether this member is obsolete
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.IsTypeDefinition
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.IsTypeDefinition
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Indicates if the entity is a type definition
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Name
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Name
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The name of the entity
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.NestedEntities
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.NestedEntities
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocEntity list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       All nested modules and types
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocEntity list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.ObsoleteMessage
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.ObsoleteMessage
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Returns the obsolete message, when this member is obsolete. When its not or no message was specified, an empty string is returned
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.OutputFile
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.OutputFile
+                  
                                      
+                  
                                      
+                  Parameters: 
+                  
                                        
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                        
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                        
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The name of the file generated for this entity
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+              
                                      
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.RecordFields
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.RecordFields
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The fields of a record type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.RequiresQualifiedAccess
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.RequiresQualifiedAccess
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Does the module have the RequiresQualifiedAccess attribute
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.SourceLocation
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.SourceLocation
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The URL of the member's source location, if any
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string option
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.StaticMembers
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.StaticMembers
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The static members of the type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.StaticParameters
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.StaticParameters
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Static parameters
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Substitutions
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Substitutions
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    Substitutions
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The substitution parameters active for generating thist content
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  Substitutions
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Symbol
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Symbol
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    FSharpEntity
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The F# compiler symbol for the type definition
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  FSharpEntity
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.TypeExtensions
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.TypeExtensions
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Type extensions of the module
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.UnionCases
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.UnionCases
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The cases of a union type
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.Url
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.Url
+                  
                                      
+                  
                                      
+                  Parameters: 
+                  
                                        
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                        
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                        
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The URL of the best link for the entity relative to "reference" directory (without the http://site.io/reference)
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    root
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+              
                                      
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.UrlBaseName
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.UrlBaseName
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       The URL base name of the primary documentation for the entity  (without the http://site.io/reference)
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      this.ValuesAndFuncs
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  this.ValuesAndFuncs
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    ApiDocMember list
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Values and functions of the module
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  ApiDocMember list
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+  
                                      
+  
                                      
+    
                                      
+      Static members
+    
                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                      
+            Static member
+          
+            Description
+            
+          
                                      
+            
                                      
+              
+                
                                      
+                  
+                    
+                      ApiDocEntity.GetUrl(urlBaseName, root, collectionName, qualify, extension)
+                    
+                  
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  Full Usage: 
+                  ApiDocEntity.GetUrl(urlBaseName, root, collectionName, qualify, extension)
+                  
                                      
+                  
                                      
+                  Parameters: 
+                  
                                        
+                    
+                      
+                        urlBaseName
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                        
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                        
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                        
+                  
                                      
+                  
                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                      
+                
                                      
+              
                                      
+            
                                      
+                                                		
+            
                                      
+              
+                
                                      
+                  
                                      
+                    
                                      
+                       Compute the URL of the best link for the entity relative to "reference" directory (without the http://site.io/reference)
+                    
                                      
+                  
                                      
+                  
                                      
+                    
+                      
+                    
+                    
                                      
+                      
+                    
                                      
+                    
                                      
+                      
+                    
                                      
+                  
                                      
+                
                                      
+                                                    
+              
                                      
+                
                                      
+                  
+                    urlBaseName
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    root
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+                
                                      
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                      
+                
                                      
+                
                                      
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                      
+                
                                      
+              
                                      
+              
                                      
+                
                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                      
+                
                                      
+              
                                      
+            
                                      
+          
                                      
+  
                                      
+
                                      
+        
+    
                                      
+
                                      
+
+
+    
+    
                                      
+        
                                        
+        
                                        Type something to start searching.
                                        
+    
                                        
+                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocentityinfo.html b/reference/fsharp-formatting-apidocs-apidocentityinfo.html
new file mode 100644
index 000000000..3b7423b0a
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocentityinfo.html
@@ -0,0 +1,749 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocEntityInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                        
+    
                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                        
+    
                                        
+        
+            
+        
+        
+        
+    
                                        
+
                                        
+
+
                                        
+    
                                        
+        
                                        
+  
                                        
+    ApiDocEntityInfo Type
+  
                                        
+  
                                        
+    
                                        
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                        
+    
                                        
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                        
+    
                                        
+      Base Type: 
+      obj
+    
                                        
+  
                                        
+  
                                        
+    
                                        
+      
                                        
+        
                                        
+           High-level information about a module definition
+        
                                        
+      
                                        
+    
                                        
+  
                                        
+  
                                        
+  
                                        
+  
                                        
+  
                                        
+  
                                        
+  
                                        
+  
                                        
+    
                                        
+      Constructors
+    
                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                        
+            Constructor
+          
+            Description
+            
+          
                                        
+            
                                        
+              
+                
                                        
+                  
+                    
+                      ApiDocEntityInfo(entity, collection, ns, parent)
+                    
+                  
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  Full Usage: 
+                  ApiDocEntityInfo(entity, collection, ns, parent)
+                  
                                        
+                  
                                        
+                  Parameters: 
+                  
+                  
                                        
+                  
+                    Returns: 
+                    ApiDocEntityInfo
+                  
+                  
                                        
+                
                                        
+              
                                        
+            
                                        
+                                                  		
+            
                                        
+              
                                        
+                
+                  
+                
+              
                                        
+              
                                        
+                
                                        
+                  
+                    entity
+                  
+                  :
+                  ApiDocEntity
+                
                                        
+                
                                        
+                
                                        
+                  
+                    collection
+                  
+                  :
+                  ApiDocCollection
+                
                                        
+                
                                        
+                
                                        
+                  
+                    ns
+                  
+                  :
+                  ApiDocNamespace
+                
                                        
+                
                                        
+                
                                        
+                  
+                    parent
+                  
+                  :
+                  ApiDocEntity option
+                
                                        
+                
                                        
+              
                                        
+              
                                        
+                
                                        
+                  
+                    Returns: 
+                  
+                  ApiDocEntityInfo
+                
                                        
+                
                                        
+              
                                        
+            
                                        
+          
                                        
+  
                                        
+  
                                        
+    
                                        
+      Instance members
+    
                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                        
+            Instance member
+          
+            Description
+            
+          
                                        
+            
                                        
+              
+                
                                        
+                  
+                    
+                      this.Collection
+                    
+                  
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  Full Usage: 
+                  this.Collection
+                  
                                        
+                  
                                        
+                  
+                    Returns: 
+                    ApiDocCollection
+                  
+                  
                                        
+                
                                        
+              
                                        
+            
                                        
+                                                  		
+            
                                        
+              
+                
                                        
+                  
                                        
+                    
                                        
+                       The collection of assemblies the entity belongs to
+                    
                                        
+                  
                                        
+                  
                                        
+                    
+                      
+                    
+                    
                                        
+                      
+                    
                                        
+                    
                                        
+                      
+                    
                                        
+                  
                                        
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  
+                    Returns: 
+                  
+                  ApiDocCollection
+                
                                        
+                
                                        
+              
                                        
+            
                                        
+          
                                        
+            
                                        
+              
+                
                                        
+                  
+                    
+                      this.Entity
+                    
+                  
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  Full Usage: 
+                  this.Entity
+                  
                                        
+                  
                                        
+                  
+                    Returns: 
+                    ApiDocEntity
+                  
+                  
                                        
+                
                                        
+              
                                        
+            
                                        
+                                                  		
+            
                                        
+              
+                
                                        
+                  
                                        
+                    
                                        
+                       The actual entity
+                    
                                        
+                  
                                        
+                  
                                        
+                    
+                      
+                    
+                    
                                        
+                      
+                    
                                        
+                    
                                        
+                      
+                    
                                        
+                  
                                        
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  
+                    Returns: 
+                  
+                  ApiDocEntity
+                
                                        
+                
                                        
+              
                                        
+            
                                        
+          
                                        
+            
                                        
+              
+                
                                        
+                  
+                    
+                      this.Namespace
+                    
+                  
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  Full Usage: 
+                  this.Namespace
+                  
                                        
+                  
                                        
+                  
+                    Returns: 
+                    ApiDocNamespace
+                  
+                  
                                        
+                
                                        
+              
                                        
+            
                                        
+                                                  		
+            
                                        
+              
+                
                                        
+                  
                                        
+                    
                                        
+                       The namespace the entity belongs to
+                    
                                        
+                  
                                        
+                  
                                        
+                    
+                      
+                    
+                    
                                        
+                      
+                    
                                        
+                    
                                        
+                      
+                    
                                        
+                  
                                        
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  
+                    Returns: 
+                  
+                  ApiDocNamespace
+                
                                        
+                
                                        
+              
                                        
+            
                                        
+          
                                        
+            
                                        
+              
+                
                                        
+                  
+                    
+                      this.ParentModule
+                    
+                  
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  Full Usage: 
+                  this.ParentModule
+                  
                                        
+                  
                                        
+                  
+                    Returns: 
+                    ApiDocEntity option
+                  
+                  
                                        
+                
                                        
+              
                                        
+            
                                        
+                                                  		
+            
                                        
+              
+                
                                        
+                  
                                        
+                    
                                        
+                       The parent module, if any.
+                    
                                        
+                  
                                        
+                  
                                        
+                    
+                      
+                    
+                    
                                        
+                      
+                    
                                        
+                    
                                        
+                      
+                    
                                        
+                  
                                        
+                
                                        
+                                                      
+              
                                        
+                
                                        
+                  
+                    Returns: 
+                  
+                  ApiDocEntity option
+                
                                        
+                
                                        
+              
                                        
+            
                                        
+          
                                        
+  
                                        
+  
                                        
+
                                        
+        
+    
                                        
+
                                        
+
+
+    
+    
                                        
+        
                                          
+        
                                          Type something to start searching.
                                          
+    
                                          
+                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocfileextensions.html b/reference/fsharp-formatting-apidocs-apidocfileextensions.html
new file mode 100644
index 000000000..c117a052a
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocfileextensions.html
@@ -0,0 +1,474 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocFileExtensions (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                          
+    
                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                          
+    
                                          
+        
+            
+        
+        
+        
+    
                                          
+
                                          
+
+
                                          
+    
                                          
+        
                                          
+  
                                          
+    ApiDocFileExtensions Type
+  
                                          
+  
                                          
+    
                                          
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                          
+    
                                          
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                          
+    
                                          
+      Base Type: 
+      obj
+    
                                          
+    
                                          
+      All Interfaces: 
+      IEquatable<ApiDocFileExtensions>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ApiDocFileExtensions>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                          
+  
                                          
+  
                                          
+    
                                          
+      
                                          
+        
                                          
+          
+        
                                          
+      
                                          
+    
                                          
+  
                                          
+  
                                          
+  
                                          
+  
                                          
+  
                                          
+  
                                          
+    
                                          
+      Record fields
+    
                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                          
+            Record Field
+          
+            Description
+            
+          
                                          
+            
                                          
+              
+                
                                          
+                  
+                    
+                      InFile
+                    
+                  
+                
                                          
+                                                        
+              
                                          
+                
                                          
+                  Full Usage: 
+                  InFile
+                  
                                          
+                  
                                          
+                  
+                    Field type: 
+                    string
+                  
+                  
                                          
+                
                                          
+              
                                          
+            
                                          
+                                                    		
+            
                                          
+              
                                          
+                
+                  
+                
+              
                                          
+              
                                          
+                
                                          
+                  
+                    Field type: 
+                  
+                  string
+                
                                          
+                
                                          
+              
                                          
+            
                                          
+          
                                          
+            
                                          
+              
+                
                                          
+                  
+                    
+                      InUrl
+                    
+                  
+                
                                          
+                                                        
+              
                                          
+                
                                          
+                  Full Usage: 
+                  InUrl
+                  
                                          
+                  
                                          
+                  
+                    Field type: 
+                    string
+                  
+                  
                                          
+                
                                          
+              
                                          
+            
                                          
+                                                    		
+            
                                          
+              
                                          
+                
+                  
+                
+              
                                          
+              
                                          
+                
                                          
+                  
+                    Field type: 
+                  
+                  string
+                
                                          
+                
                                          
+              
                                          
+            
                                          
+          
                                          
+  
                                          
+  
                                          
+  
                                          
+  
                                          
+  
                                          
+
                                          
+        
+    
                                          
+
                                          
+
+
+    
+    
                                          
+        
                                            
+        
                                            Type something to start searching.
                                            
+    
                                            
+                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidochtml.html b/reference/fsharp-formatting-apidocs-apidochtml.html
new file mode 100644
index 000000000..f64ecd785
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidochtml.html
@@ -0,0 +1,595 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocHtml (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                            
+    
                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                            
+    
                                            
+        
+            
+        
+        
+        
+    
                                            
+
                                            
+
+
                                            
+    
                                            
+        
                                            
+  
                                            
+    ApiDocHtml Type
+  
                                            
+  
                                            
+    
                                            
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                            
+    
                                            
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                            
+    
                                            
+      Base Type: 
+      obj
+    
                                            
+  
                                            
+  
                                            
+    
                                            
+      
                                            
+        
                                            
+           Represents some HTML formatted by model generation
+        
                                            
+      
                                            
+    
                                            
+  
                                            
+  
                                            
+  
                                            
+  
                                            
+  
                                            
+  
                                            
+  
                                            
+  
                                            
+    
                                            
+      Constructors
+    
                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                            
+            Constructor
+          
+            Description
+            
+          
                                            
+            
                                            
+              
+                
                                            
+                  
+                    
+                      ApiDocHtml(html, id)
+                    
+                  
+                
                                            
+                                                          
+              
                                            
+                
                                            
+                  Full Usage: 
+                  ApiDocHtml(html, id)
+                  
                                            
+                  
                                            
+                  Parameters: 
+                  
                                              
+                    
+                      
+                        html
+                      
+                      :
+                      string
+                    
+                    
                                              
+                    
+                      
+                        id
+                      
+                      :
+                      string option
+                    
+                    
                                              
+                  
                                            
+                  
                                            
+                  
+                    Returns: 
+                    ApiDocHtml
+                  
+                  
                                            
+                
                                            
+              
                                            
+            
                                            
+                                                      		
+            
                                            
+              
                                            
+                
+                  
+                
+              
                                            
+              
                                            
+                
                                            
+                  
+                    html
+                  
+                  :
+                  string
+                
                                            
+                
                                            
+                
                                            
+                  
+                    id
+                  
+                  :
+                  string option
+                
                                            
+                
                                            
+              
                                            
+              
                                            
+                
                                            
+                  
+                    Returns: 
+                  
+                  ApiDocHtml
+                
                                            
+                
                                            
+              
                                            
+            
                                            
+          
                                            
+  
                                            
+  
                                            
+    
                                            
+      Instance members
+    
                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                            
+            Instance member
+          
+            Description
+            
+          
                                            
+            
                                            
+              
+                
                                            
+                  
+                    
+                      this.HtmlText
+                    
+                  
+                
                                            
+                                                          
+              
                                            
+                
                                            
+                  Full Usage: 
+                  this.HtmlText
+                  
                                            
+                  
                                            
+                  
+                    Returns: 
+                    string
+                  
+                  
                                            
+                
                                            
+              
                                            
+            
                                            
+                                                      		
+            
                                            
+              
+                
                                            
+                  
                                            
+                    
                                            
+                       Get the HTML text of the HTML section
+                    
                                            
+                  
                                            
+                  
                                            
+                    
+                      
+                    
+                    
                                            
+                      
+                    
                                            
+                    
                                            
+                      
+                    
                                            
+                  
                                            
+                
                                            
+                                                          
+              
                                            
+                
                                            
+                  
+                    Returns: 
+                  
+                  string
+                
                                            
+                
                                            
+              
                                            
+            
                                            
+          
                                            
+            
                                            
+              
+                
                                            
+                  
+                    
+                      this.Id
+                    
+                  
+                
                                            
+                                                          
+              
                                            
+                
                                            
+                  Full Usage: 
+                  this.Id
+                  
                                            
+                  
                                            
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                            
+                
                                            
+              
                                            
+            
                                            
+                                                      		
+            
                                            
+              
+                
                                            
+                  
                                            
+                    
                                            
+                       Get the Id of the element when rendered to html, if any
+                    
                                            
+                  
                                            
+                  
                                            
+                    
+                      
+                    
+                    
                                            
+                      
+                    
                                            
+                    
                                            
+                      
+                    
                                            
+                  
                                            
+                
                                            
+                                                          
+              
                                            
+                
                                            
+                  
+                    Returns: 
+                  
+                  string option
+                
                                            
+                
                                            
+              
                                            
+            
                                            
+          
                                            
+  
                                            
+  
                                            
+
                                            
+        
+    
                                            
+
                                            
+
+
+    
+    
                                            
+        
                                              
+        
                                              Type something to start searching.
                                              
+    
                                              
+                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocinput.html b/reference/fsharp-formatting-apidocs-apidocinput.html
new file mode 100644
index 000000000..cef0fa7cd
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocinput.html
@@ -0,0 +1,1007 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocInput (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                              
+    
                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                              
+    
                                              
+        
+            
+        
+        
+        
+    
                                              
+
                                              
+
+
                                              
+    
                                              
+        
                                              
+  
                                              
+    ApiDocInput Type
+  
                                              
+  
                                              
+    
                                              
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                              
+    
                                              
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                              
+    
                                              
+      Base Type: 
+      obj
+    
                                              
+    
                                              
+      All Interfaces: 
+      IEquatable<ApiDocInput>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ApiDocInput>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                              
+  
                                              
+  
                                              
+    
                                              
+      
                                              
+        
                                              
+           Represents an input assembly for API doc generation
+        
                                              
+      
                                              
+    
                                              
+  
                                              
+  
                                              
+  
                                              
+  
                                              
+  
                                              
+  
                                              
+    
                                              
+      Record fields
+    
                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                              
+            Record Field
+          
+            Description
+            
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      MarkdownComments
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  MarkdownComments
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       Whether the input uses markdown comments
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  bool
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      Path
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  Path
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    string
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       The path to the assembly
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  string
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      PublicOnly
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  PublicOnly
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       Whether to generate only public things
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  bool
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      SourceFolder
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  SourceFolder
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       The compile-time source folder
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  string option
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      SourceRepo
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  SourceRepo
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       The URL the the source repo where the source code lives
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  string option
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      Substitutions
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  Substitutions
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    Substitutions option
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       The substitutionss active for this input. If specified these
+ are used instead of the overall substitutions.  This allows different parameters (e.g.
+ different authors) for each assembly in a collection.
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  Substitutions option
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      Warn
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  Warn
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       Whether doc processing should warn on missing comments
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  bool
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      XmlFile
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  XmlFile
+                  
                                              
+                  
                                              
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
+                
                                              
+                  
                                              
+                    
                                              
+                       Override the default XML file (normally assumed to live alongside)
+                    
                                              
+                  
                                              
+                  
                                              
+                    
+                      
+                    
+                  
                                              
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  
+                    Field type: 
+                  
+                  string option
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+  
                                              
+  
                                              
+  
                                              
+  
                                              
+  
                                              
+    
                                              
+      Static members
+    
                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                              
+            Static member
+          
+            Description
+            
+          
                                              
+            
                                              
+              
+                
                                              
+                  
+                    
+                      ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn)
+                    
+                  
+                
                                              
+                                                            
+              
                                              
+                
                                              
+                  Full Usage: 
+                  ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn)
+                  
                                              
+                  
                                              
+                  Parameters: 
+                  
                                                
+                    
+                      
+                        assemblyPath
+                      
+                      :
+                      string
+                    
+                    
                                                
+                    
+                      
+                        ?mdcomments
+                      
+                      :
+                      bool
+                    
+                    
                                                
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      Substitutions
+                    
+                    
                                                
+                    
+                      
+                        ?sourceRepo
+                      
+                      :
+                      string
+                    
+                    
                                                
+                    
+                      
+                        ?sourceFolder
+                      
+                      :
+                      string
+                    
+                    
                                                
+                    
+                      
+                        ?publicOnly
+                      
+                      :
+                      bool
+                    
+                    
                                                
+                    
+                      
+                        ?warn
+                      
+                      :
+                      bool
+                    
+                    
                                                
+                  
                                              
+                  
                                              
+                  
+                    Returns: 
+                    ApiDocInput
+                  
+                  
                                              
+                
                                              
+              
                                              
+            
                                              
+                                                        		
+            
                                              
+              
                                              
+                
+                  
+                
+              
                                              
+              
                                              
+                
                                              
+                  
+                    assemblyPath
+                  
+                  :
+                  string
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?mdcomments
+                  
+                  :
+                  bool
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?substitutions
+                  
+                  :
+                  Substitutions
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?sourceRepo
+                  
+                  :
+                  string
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?sourceFolder
+                  
+                  :
+                  string
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?publicOnly
+                  
+                  :
+                  bool
+                
                                              
+                
                                              
+                
                                              
+                  
+                    ?warn
+                  
+                  :
+                  bool
+                
                                              
+                
                                              
+              
                                              
+              
                                              
+                
                                              
+                  
+                    Returns: 
+                  
+                  ApiDocInput
+                
                                              
+                
                                              
+              
                                              
+            
                                              
+          
                                              
+  
                                              
+
                                              
+        
+    
                                              
+
                                              
+
+
+    
+    
                                              
+        
                                                
+        
                                                Type something to start searching.
                                                
+    
                                                
+                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocmember.html b/reference/fsharp-formatting-apidocs-apidocmember.html
new file mode 100644
index 000000000..332a7cdaf
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocmember.html
@@ -0,0 +1,2441 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocMember (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                
+    
                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                
+    
                                                
+        
+            
+        
+        
+        
+    
                                                
+
                                                
+
+
                                                
+    
                                                
+        
                                                
+  
                                                
+    ApiDocMember Type
+  
                                                
+  
                                                
+    
                                                
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                
+    
                                                
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                
+    
                                                
+      Base Type: 
+      obj
+    
                                                
+  
                                                
+  
                                                
+    
                                                
+      
                                                
+        
                                                
+           Represents an method, property, constructor, function or value, record field, union case or static parameter
+ integrated with its associated documentation. Includes extension members.
+        
                                                
+      
                                                
+    
                                                
+  
                                                
+  
                                                
+  
                                                
+  
                                                
+  
                                                
+  
                                                
+  
                                                
+  
                                                
+    
                                                
+      Constructors
+    
                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                
+            Constructor
+          
+            Description
+            
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)
+                  
                                                
+                  
                                                
+                  Parameters: 
+                  
                                                  
+                    
+                      
+                        displayName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        attributes
+                      
+                      :
+                      ApiDocAttribute list
+                    
+                    
                                                  
+                    
+                      
+                        entityUrlBaseName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        kind
+                      
+                      :
+                      ApiDocMemberKind
+                    
+                    
                                                  
+                    
+                      
+                        cat
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        catidx
+                      
+                      :
+                      int
+                    
+                    
                                                  
+                    
+                      
+                        exclude
+                      
+                      :
+                      bool
+                    
+                    
                                                  
+                    
+                      
+                        details
+                      
+                      :
+                      ApiDocMemberDetails
+                    
+                    
                                                  
+                    
+                      
+                        comment
+                      
+                      :
+                      ApiDocComment
+                    
+                    
                                                  
+                    
+                      
+                        symbol
+                      
+                      :
+                      FSharpSymbol
+                    
+                    
                                                  
+                    
+                      
+                        warn
+                      
+                      :
+                      bool
+                    
+                    
                                                  
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocMember
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
                                                
+                
+                  
+                
+              
                                                
+              
                                                
+                
                                                
+                  
+                    displayName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    attributes
+                  
+                  :
+                  ApiDocAttribute list
+                
                                                
+                
                                                
+                
                                                
+                  
+                    entityUrlBaseName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    kind
+                  
+                  :
+                  ApiDocMemberKind
+                
                                                
+                
                                                
+                
                                                
+                  
+                    cat
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    catidx
+                  
+                  :
+                  int
+                
                                                
+                
                                                
+                
                                                
+                  
+                    exclude
+                  
+                  :
+                  bool
+                
                                                
+                
                                                
+                
                                                
+                  
+                    details
+                  
+                  :
+                  ApiDocMemberDetails
+                
                                                
+                
                                                
+                
                                                
+                  
+                    comment
+                  
+                  :
+                  ApiDocComment
+                
                                                
+                
                                                
+                
                                                
+                  
+                    symbol
+                  
+                  :
+                  FSharpSymbol
+                
                                                
+                
                                                
+                
                                                
+                  
+                    warn
+                  
+                  :
+                  bool
+                
                                                
+                
                                                
+              
                                                
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocMember
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+  
                                                
+  
                                                
+    
                                                
+      Instance members
+    
                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                
+            Instance member
+          
+            Description
+            
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Attributes
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Attributes
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocAttribute list
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The declared attributes of the member
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocAttribute list
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Category
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Category
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The category
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.CategoryIndex
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.CategoryIndex
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The category index
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  int
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Comment
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Comment
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocComment
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The attached comment
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocComment
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.CompiledName
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.CompiledName
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The member's compiled name, if any
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string option
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.CustomOperationName
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.CustomOperationName
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Returns the custom operation name, when this attribute is the CustomOperationAttribute.
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string option
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Details
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Details
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocMemberDetails
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The members details
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocMemberDetails
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Exclude
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Exclude
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The exclude flag
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.ExtendedType
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.ExtendedType
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    (FSharpEntity * ApiDocHtml) option
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The type extended by an extension member, if any
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  (FSharpEntity * ApiDocHtml) option
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.FormatCompiledName
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.FormatCompiledName
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Formats the compiled name
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.FormatModifiers
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.FormatModifiers
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Formats modifiers
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.FormatTypeArguments
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.FormatTypeArguments
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Formats type arguments
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string option
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.IsObsolete
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.IsObsolete
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Gets a value indicating whether this member is obsolete
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.IsRequireQualifiedAccessAttribute
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.IsRequireQualifiedAccessAttribute
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
                                                
+                
+                  
+                
+              
                                                
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Kind
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Kind
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocMemberKind
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The kind of the member
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocMemberKind
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Modifiers
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Modifiers
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string list
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The member's modifiers
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string list
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Name
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Name
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Name of the member
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.ObsoleteMessage
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.ObsoleteMessage
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       Returns the obsolete message, when this member is obsolete. When its not or no message was specified, an empty string is returned
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Parameters
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Parameters
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    (type) list
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The member's parameters and associated documentation
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  (type) list
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.ReturnInfo
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.ReturnInfo
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    (type)
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The return section in a typical tooltip
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  (type)
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.SourceLocation
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.SourceLocation
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The URL of the member's source location, if any
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string option
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Symbol
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Symbol
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    FSharpSymbol
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The symbol this member is related to
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  FSharpSymbol
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.TypeArguments
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.TypeArguments
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string list
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The member's type arguments
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string list
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.Url
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.Url
+                  
                                                
+                  
                                                
+                  Parameters: 
+                  
                                                  
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                  
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The URL of the best link documentation for the item relative to "reference" directory (without the http://site.io/reference)
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    root
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                
+                
                                                
+                
                                                
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+              
                                                
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.UrlBaseName
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.UrlBaseName
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The URL base name of the best link documentation for the item (without the http://site.io/reference)
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      this.UsageHtml
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  this.UsageHtml
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    ApiDocHtml
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The usage section in a typical tooltip
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  ApiDocHtml
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+  
                                                
+  
                                                
+    
                                                
+      Static members
+    
                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                
+            Static member
+          
+            Description
+            
+          
                                                
+            
                                                
+              
+                
                                                
+                  
+                    
+                      ApiDocMember.GetUrl(entityUrlBaseName, displayName, root, collectionName, qualify, extension)
+                    
+                  
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  Full Usage: 
+                  ApiDocMember.GetUrl(entityUrlBaseName, displayName, root, collectionName, qualify, extension)
+                  
                                                
+                  
                                                
+                  Parameters: 
+                  
                                                  
+                    
+                      
+                        entityUrlBaseName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        displayName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                  
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                  
+                  
                                                
+                  
                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                
+                
                                                
+              
                                                
+            
                                                
+                                                          		
+            
                                                
+              
+                
                                                
+                  
                                                
+                    
                                                
+                       The URL of the best link documentation for the item relative to "reference" directory (without the http://site.io/reference)
+                    
                                                
+                  
                                                
+                  
                                                
+                    
+                      
+                    
+                    
                                                
+                      
+                    
                                                
+                    
                                                
+                      
+                    
                                                
+                  
                                                
+                
                                                
+                                                              
+              
                                                
+                
                                                
+                  
+                    entityUrlBaseName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    displayName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    root
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+                
                                                
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                
+                
                                                
+                
                                                
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                
+                
                                                
+              
                                                
+              
                                                
+                
                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                
+                
                                                
+              
                                                
+            
                                                
+          
                                                
+  
                                                
+
                                                
+        
+    
                                                
+
                                                
+
+
+    
+    
                                                
+        
                                                  
+        
                                                  Type something to start searching.
                                                  
+    
                                                  
+                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocmemberdetails.html b/reference/fsharp-formatting-apidocs-apidocmemberdetails.html
new file mode 100644
index 000000000..502d8c688
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocmemberdetails.html
@@ -0,0 +1,542 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocMemberDetails (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                  
+    
                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                  
+    
                                                  
+        
+            
+        
+        
+        
+    
                                                  
+
                                                  
+
+
                                                  
+    
                                                  
+        
                                                  
+  
                                                  
+    ApiDocMemberDetails Type
+  
                                                  
+  
                                                  
+    
                                                  
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                  
+    
                                                  
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                  
+    
                                                  
+      Base Type: 
+      obj
+    
                                                  
+    
                                                  
+      All Interfaces: 
+      IEquatable<ApiDocMemberDetails>
+      , 
+      IStructuralEquatable
+    
                                                  
+  
                                                  
+  
                                                  
+    
                                                  
+      
                                                  
+        
                                                  
+          
+        
                                                  
+      
                                                  
+    
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+    
                                                  
+      Union cases
+    
                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                  
+            Union case
+          
+            Description
+            
+          
                                                  
+            
                                                  
+              
+                
                                                  
+                  
+                    
+                      ApiDocMemberDetails(usageHtml, paramTypes, returnType, modifiers, typars, extendedType, location, compiledName)
+                    
+                  
+                
                                                  
+                                                                
+              
                                                  
+                
                                                  
+                  Full Usage: 
+                  ApiDocMemberDetails(usageHtml, paramTypes, returnType, modifiers, typars, extendedType, location, compiledName)
+                  
                                                  
+                  
                                                  
+                  Parameters: 
+                  
+                  
                                                  
+                
                                                  
+              
                                                  
+            
                                                  
+                                                            		
+            
                                                  
+              
                                                  
+                
+                  
+                
+              
                                                  
+              
                                                  
+                
                                                  
+                  
+                    usageHtml
+                  
+                  :
+                  ApiDocHtml
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    paramTypes
+                  
+                  :
+                  (Choice<FSharpParameter, FSharpField> * string * ApiDocHtml) list
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    returnType
+                  
+                  :
+                  (FSharpType * ApiDocHtml) option
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    modifiers
+                  
+                  :
+                  string list
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    typars
+                  
+                  :
+                  string list
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    extendedType
+                  
+                  :
+                  (FSharpEntity * ApiDocHtml) option
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    location
+                  
+                  :
+                  string option
+                
                                                  
+                
                                                  
+                
                                                  
+                  
+                    compiledName
+                  
+                  :
+                  string option
+                
                                                  
+                
                                                  
+              
                                                  
+            
                                                  
+          
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+  
                                                  
+
                                                  
+        
+    
                                                  
+
                                                  
+
+
+    
+    
                                                  
+        
                                                    
+        
                                                    Type something to start searching.
                                                    
+    
                                                    
+                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocmemberkind.html b/reference/fsharp-formatting-apidocs-apidocmemberkind.html
new file mode 100644
index 000000000..b02908e1b
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocmemberkind.html
@@ -0,0 +1,827 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocMemberKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                    
+    
                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                    
+    
                                                    
+        
+            
+        
+        
+        
+    
                                                    
+
                                                    
+
+
                                                    
+    
                                                    
+        
                                                    
+  
                                                    
+    ApiDocMemberKind Type
+  
                                                    
+  
                                                    
+    
                                                    
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                    
+    
                                                    
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                    
+    
                                                    
+      Base Type: 
+      Enum
+    
                                                    
+    
                                                    
+      All Interfaces: 
+      IComparable
+      , 
+      IConvertible
+      , 
+      ISpanFormattable
+      , 
+      IFormattable
+    
                                                    
+    
                                                    
+      Kind: Struct
+    
                                                    
+    
                                                    
+      This is an enum type definition
+    
                                                    
+  
                                                    
+  
                                                    
+    
                                                    
+      
                                                    
+        
                                                    
+           Represents the kind of member
+        
                                                    
+      
                                                    
+    
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+    
                                                    
+      Record fields
+    
                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                    
+            Record Field
+          
+            Description
+            
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      ActivePattern
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  ActivePattern
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      Constructor
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  Constructor
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      InstanceMember
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  InstanceMember
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      RecordField
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  RecordField
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      StaticMember
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  StaticMember
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      StaticParameter
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  StaticParameter
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      TypeExtension
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  TypeExtension
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      UnionCase
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  UnionCase
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+            
                                                    
+              
+                
                                                    
+                  
+                    
+                      ValueOrFunction
+                    
+                  
+                
                                                    
+                                                                  
+              
                                                    
+                
                                                    
+                  Full Usage: 
+                  ValueOrFunction
+                  
                                                    
+                  
                                                    
+                  
+                    Field type: 
+                    ApiDocMemberKind
+                  
+                  
                                                    
+                  Modifiers: 
+                  static
+                  
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+                                                              		
+            
                                                    
+              
                                                    
+                
+                  
+                
+              
                                                    
+              
                                                    
+                
                                                    
+                  
+                    Field type: 
+                  
+                  ApiDocMemberKind
+                
                                                    
+                
                                                    
+              
                                                    
+            
                                                    
+          
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+  
                                                    
+
                                                    
+        
+    
                                                    
+
                                                    
+
+
+    
+    
                                                    
+        
                                                      
+        
                                                      Type something to start searching.
                                                      
+    
                                                      
+                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocmodel.html b/reference/fsharp-formatting-apidocs-apidocmodel.html
new file mode 100644
index 000000000..a32da87c1
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocmodel.html
@@ -0,0 +1,982 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocModel (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                      
+    
                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                      
+    
                                                      
+        
+            
+        
+        
+        
+    
                                                      
+
                                                      
+
+
                                                      
+    
                                                      
+        
                                                      
+  
                                                      
+    ApiDocModel Type
+  
                                                      
+  
                                                      
+    
                                                      
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                      
+    
                                                      
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                      
+    
                                                      
+      Base Type: 
+      obj
+    
                                                      
+  
                                                      
+  
                                                      
+    
                                                      
+      
                                                      
+        
                                                      
+           Represents a set of assemblies integrated with their associated documentation
+        
                                                      
+      
                                                      
+    
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+  
                                                      
+    
                                                      
+      Instance members
+    
                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                      
+            Instance member
+          
+            Description
+            
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.Collection
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.Collection
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    ApiDocCollection
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       The full list of all entities
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  ApiDocCollection
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.EntityInfos
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.EntityInfos
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    ApiDocEntityInfo list
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       The full list of all entities
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  ApiDocEntityInfo list
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.FileExtensions
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.FileExtensions
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    ApiDocFileExtensions
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       Specifies file extensions to use in files and URLs
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  ApiDocFileExtensions
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.IndexFileUrl
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.IndexFileUrl
+                  
                                                      
+                  
                                                      
+                  Parameters: 
+                  
                                                        
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                                        
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                        
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                        
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                        
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       URL of the 'index.html' for the reference documentation for the model
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    root
+                  
+                  :
+                  string
+                
                                                      
+                
                                                      
+                
                                                      
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                      
+                
                                                      
+                
                                                      
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                      
+                
                                                      
+                
                                                      
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                      
+                
                                                      
+              
                                                      
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.IndexOutputFile
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.IndexOutputFile
+                  
                                                      
+                  
                                                      
+                  Parameters: 
+                  
                                                        
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                        
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                        
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                        
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       URL of the 'index.html' for the reference documentation for the model
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                      
+                
                                                      
+                
                                                      
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                      
+                
                                                      
+                
                                                      
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                      
+                
                                                      
+              
                                                      
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.Qualify
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.Qualify
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       Indicates if each collection is being qualified by its collection name, e.g. 'reference/FSharp.Core'
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.Root
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.Root
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       The root URL for the entire generation, normally '/'
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+            
                                                      
+              
+                
                                                      
+                  
+                    
+                      this.Substitutions
+                    
+                  
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  Full Usage: 
+                  this.Substitutions
+                  
                                                      
+                  
                                                      
+                  
+                    Returns: 
+                    Substitutions
+                  
+                  
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+                                                                		
+            
                                                      
+              
+                
                                                      
+                  
                                                      
+                    
                                                      
+                       The substitutions.  Different substitutions can also be used for each specific input
+                    
                                                      
+                  
                                                      
+                  
                                                      
+                    
+                      
+                    
+                    
                                                      
+                      
+                    
                                                      
+                    
                                                      
+                      
+                    
                                                      
+                  
                                                      
+                
                                                      
+                                                                    
+              
                                                      
+                
                                                      
+                  
+                    Returns: 
+                  
+                  Substitutions
+                
                                                      
+                
                                                      
+              
                                                      
+            
                                                      
+          
                                                      
+  
                                                      
+  
                                                      
+
                                                      
+        
+    
                                                      
+
                                                      
+
+
+    
+    
                                                      
+        
                                                        
+        
                                                        Type something to start searching.
                                                        
+    
                                                        
+                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocnamespace.html b/reference/fsharp-formatting-apidocs-apidocnamespace.html
new file mode 100644
index 000000000..1864e6d81
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocnamespace.html
@@ -0,0 +1,1117 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocNamespace (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                        
+    
                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                        
+    
                                                        
+        
+            
+        
+        
+        
+    
                                                        
+
                                                        
+
+
                                                        
+    
                                                        
+        
                                                        
+  
                                                        
+    ApiDocNamespace Type
+  
                                                        
+  
                                                        
+    
                                                        
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                        
+    
                                                        
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                        
+    
                                                        
+      Base Type: 
+      obj
+    
                                                        
+  
                                                        
+  
                                                        
+    
                                                        
+      
                                                        
+        
                                                        
+           Represents a namespace integrated with its associated documentation
+        
                                                        
+      
                                                        
+    
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+  
                                                        
+    
                                                        
+      Constructors
+    
                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                        
+            Constructor
+          
+            Description
+            
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      ApiDocNamespace(name, modifiers, substitutions, nsdocs)
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  ApiDocNamespace(name, modifiers, substitutions, nsdocs)
+                  
                                                        
+                  
                                                        
+                  Parameters: 
+                  
+                  
                                                        
+                  
+                    Returns: 
+                    ApiDocNamespace
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
                                                        
+                
+                  
+                
+              
                                                        
+              
                                                        
+                
                                                        
+                  
+                    name
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    modifiers
+                  
+                  :
+                  ApiDocEntity list
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    nsdocs
+                  
+                  :
+                  ApiDocComment option
+                
                                                        
+                
                                                        
+              
                                                        
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  ApiDocNamespace
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+  
                                                        
+  
                                                        
+    
                                                        
+      Instance members
+    
                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                        
+            Instance member
+          
+            Description
+            
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.Entities
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.Entities
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    ApiDocEntity list
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       All modules in the namespace
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  ApiDocEntity list
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.Name
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.Name
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The name of the namespace
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.NamespaceDocs
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.NamespaceDocs
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    ApiDocComment option
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The summary text for the namespace
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  ApiDocComment option
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.OutputFile
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.OutputFile
+                  
                                                        
+                  
                                                        
+                  Parameters: 
+                  
                                                          
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                          
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                          
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                          
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The name of the file generated for this entity
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.Substitutions
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.Substitutions
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    Substitutions
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The substitution substitutions active for generating thist content
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  Substitutions
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.Url
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.Url
+                  
                                                        
+                  
                                                        
+                  Parameters: 
+                  
                                                          
+                    
+                      
+                        root
+                      
+                      :
+                      string
+                    
+                    
                                                          
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                    
+                    
                                                          
+                    
+                      
+                        qualify
+                      
+                      :
+                      bool
+                    
+                    
                                                          
+                    
+                      
+                        extension
+                      
+                      :
+                      string
+                    
+                    
                                                          
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The URL of the best link documentation for the item (without the http://site.io/reference)
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    root
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    qualify
+                  
+                  :
+                  bool
+                
                                                        
+                
                                                        
+                
                                                        
+                  
+                    extension
+                  
+                  :
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.UrlBaseName
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.UrlBaseName
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The base name for the generated file
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+            
                                                        
+              
+                
                                                        
+                  
+                    
+                      this.UrlHash
+                    
+                  
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  Full Usage: 
+                  this.UrlHash
+                  
                                                        
+                  
                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+                                                                  		
+            
                                                        
+              
+                
                                                        
+                  
                                                        
+                    
                                                        
+                       The hash label for the URL with the overall namespaces file
+                    
                                                        
+                  
                                                        
+                  
                                                        
+                    
+                      
+                    
+                    
                                                        
+                      
+                    
                                                        
+                    
                                                        
+                      
+                    
                                                        
+                  
                                                        
+                
                                                        
+                                                                      
+              
                                                        
+                
                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                        
+                
                                                        
+              
                                                        
+            
                                                        
+          
                                                        
+  
                                                        
+  
                                                        
+
                                                        
+        
+    
                                                        
+
                                                        
+
+
+    
+    
                                                        
+        
                                                          
+        
                                                          Type something to start searching.
                                                          
+    
                                                          
+                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocs.html b/reference/fsharp-formatting-apidocs-apidocs.html
new file mode 100644
index 000000000..276a990d5
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocs.html
@@ -0,0 +1,1365 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocs (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                          
+    
                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                          
+    
                                                          
+        
+            
+        
+        
+        
+    
                                                          
+
                                                          
+
+
                                                          
+    
                                                          
+        
                                                          
+  
                                                          
+    ApiDocs Type
+  
                                                          
+  
                                                          
+    
                                                          
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                          
+    
                                                          
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                          
+    
                                                          
+      Base Type: 
+      obj
+    
                                                          
+  
                                                          
+  
                                                          
+    
                                                          
+      
                                                          
+        
                                                          
+          
+  This type exposes the functionality for producing documentation model from `dll` files with associated `xml` files
+  generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the `Generate` method.
+ 
+        
                                                          
+      
                                                          
+    
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+  
                                                          
+    
                                                          
+      Static members
+    
                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                          
+            Static member
+          
+            Description
+            
+          
                                                          
+            
                                                          
+              
+                
                                                          
+                  
+                    
+                      ApiDocs.GenerateHtml(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)
+                    
+                  
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  Full Usage: 
+                  ApiDocs.GenerateHtml(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)
+                  
                                                          
+                  
                                                          
+                  Parameters: 
+                  
                                                            
+                    
+                      
+                        inputs
+                      
+                      :
+                      ApiDocInput list
+                       - 
+                      the components to generate documentation for
+                    
+                    
                                                            
+                    
+                      
+                        output
+                      
+                      :
+                      string
+                       - 
+                      the output directory
+                    
+                    
                                                            
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                       - 
+                      the overall collection name
+                    
+                    
                                                            
+                    
+                      
+                        substitutions
+                      
+                      :
+                      Substitutions
+                       - 
+                      the substitutions to use in content and templates
+                    
+                    
                                                            
+                    
+                      
+                        ?template
+                      
+                      :
+                      string
+                       - 
+                      the template to use for each documentation page
+                    
+                    
                                                            
+                    
+                      
+                        ?root
+                      
+                      :
+                      string
+                       - 
+                      The root url of the generated documentation within the website
+                    
+                    
                                                            
+                    
+                      
+                        ?qualify
+                      
+                      :
+                      bool
+                       - 
+                      qualify the output set by collection name, e.g. `reference/FSharp.Core/...`
+                    
+                    
                                                            
+                    
+                      
+                        ?libDirs
+                      
+                      :
+                      string list
+                       - 
+                      Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                    
+                    
                                                            
+                    
+                      
+                        ?otherFlags
+                      
+                      :
+                      string list
+                       - 
+                      Additional flags that are passed to the F# compiler to specify references explicitly etc.
+                    
+                    
                                                            
+                    
+                      
+                        ?urlRangeHighlight
+                      
+                      :
+                      Uri -> int -> int -> string
+                       - 
+                      A function that can be used to override the default way of generating GitHub links
+                    
+                    
                                                            
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                            
+                  
                                                          
+                  
                                                          
+                  
+                    Returns: 
+                    ApiDocModel * ApiDocsSearchIndexEntry[]
+                  
+                  
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+                                                                    		
+            
                                                          
+              
+                
                                                          
+                  
                                                          
+                    
                                                          
+                      
+ Generates default HTML pages for the assemblies specified by the `inputs` parameter
+ 
+                    
                                                          
+                  
                                                          
+                  
                                                          
+                    
+                      
+                    
+                    
                                                          
+                      
+                    
                                                          
+                    
                                                          
+                      
+                    
                                                          
+                  
                                                          
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  
+                    inputs
+                  
+                  :
+                  ApiDocInput list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the components to generate documentation for
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    output
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the output directory
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the overall collection name
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the substitutions to use in content and templates
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?template
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the template to use for each documentation page
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?root
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    The root url of the generated documentation within the website
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?qualify
+                  
+                  :
+                  bool
+                
                                                          
+                
                                                          
+                  
                                                          
+                    qualify the output set by collection name, e.g. `reference/FSharp.Core/...`
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?libDirs
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?otherFlags
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Additional flags that are passed to the F# compiler to specify references explicitly etc.
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?urlRangeHighlight
+                  
+                  :
+                  Uri -> int -> int -> string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    A function that can be used to override the default way of generating GitHub links
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                          
+                
                                                          
+              
                                                          
+              
                                                          
+                
                                                          
+                  
+                    Returns: 
+                  
+                  ApiDocModel * ApiDocsSearchIndexEntry[]
+                
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+          
                                                          
+            
                                                          
+              
+                
                                                          
+                  
+                    
+                      ApiDocs.GenerateMarkdown(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)
+                    
+                  
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  Full Usage: 
+                  ApiDocs.GenerateMarkdown(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)
+                  
                                                          
+                  
                                                          
+                  Parameters: 
+                  
                                                            
+                    
+                      
+                        inputs
+                      
+                      :
+                      ApiDocInput list
+                       - 
+                      the components to generate documentation for
+                    
+                    
                                                            
+                    
+                      
+                        output
+                      
+                      :
+                      string
+                       - 
+                      the output directory
+                    
+                    
                                                            
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                       - 
+                      the overall collection name
+                    
+                    
                                                            
+                    
+                      
+                        substitutions
+                      
+                      :
+                      Substitutions
+                       - 
+                      the substitutions to use in content and templates
+                    
+                    
                                                            
+                    
+                      
+                        ?template
+                      
+                      :
+                      string
+                       - 
+                      the template to use for each documentation page
+                    
+                    
                                                            
+                    
+                      
+                        ?root
+                      
+                      :
+                      string
+                       - 
+                      The root url of the generated documentation within the website
+                    
+                    
                                                            
+                    
+                      
+                        ?qualify
+                      
+                      :
+                      bool
+                       - 
+                      qualify the output set by collection name, e.g. `reference/FSharp.Core/...`
+                    
+                    
                                                            
+                    
+                      
+                        ?libDirs
+                      
+                      :
+                      string list
+                       - 
+                      Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                    
+                    
                                                            
+                    
+                      
+                        ?otherFlags
+                      
+                      :
+                      string list
+                       - 
+                      Additional flags that are passed to the F# compiler to specify references explicitly etc.
+                    
+                    
                                                            
+                    
+                      
+                        ?urlRangeHighlight
+                      
+                      :
+                      Uri -> int -> int -> string
+                       - 
+                      A function that can be used to override the default way of generating GitHub links
+                    
+                    
                                                            
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                            
+                  
                                                          
+                  
                                                          
+                  
+                    Returns: 
+                    ApiDocModel * ApiDocsSearchIndexEntry[]
+                  
+                  
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+                                                                    		
+            
                                                          
+              
+                
                                                          
+                  
                                                          
+                    
                                                          
+                      
+ Generates default Markdown pages for the assemblies specified by the `inputs` parameter
+ 
+                    
                                                          
+                  
                                                          
+                  
                                                          
+                    
+                      
+                    
+                    
                                                          
+                      
+                    
                                                          
+                    
                                                          
+                      
+                    
                                                          
+                  
                                                          
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  
+                    inputs
+                  
+                  :
+                  ApiDocInput list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the components to generate documentation for
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    output
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the output directory
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the overall collection name
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the substitutions to use in content and templates
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?template
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the template to use for each documentation page
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?root
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    The root url of the generated documentation within the website
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?qualify
+                  
+                  :
+                  bool
+                
                                                          
+                
                                                          
+                  
                                                          
+                    qualify the output set by collection name, e.g. `reference/FSharp.Core/...`
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?libDirs
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?otherFlags
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Additional flags that are passed to the F# compiler to specify references explicitly etc.
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?urlRangeHighlight
+                  
+                  :
+                  Uri -> int -> int -> string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    A function that can be used to override the default way of generating GitHub links
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                          
+                
                                                          
+              
                                                          
+              
                                                          
+                
                                                          
+                  
+                    Returns: 
+                  
+                  ApiDocModel * ApiDocsSearchIndexEntry[]
+                
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+          
                                                          
+            
                                                          
+              
+                
                                                          
+                  
+                    
+                      ApiDocs.GenerateModel(inputs, collectionName, substitutions, ?qualify, ?libDirs, ?otherFlags, ?root, ?urlRangeHighlight, ?onError, ?extension)
+                    
+                  
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  Full Usage: 
+                  ApiDocs.GenerateModel(inputs, collectionName, substitutions, ?qualify, ?libDirs, ?otherFlags, ?root, ?urlRangeHighlight, ?onError, ?extension)
+                  
                                                          
+                  
                                                          
+                  Parameters: 
+                  
                                                            
+                    
+                      
+                        inputs
+                      
+                      :
+                      ApiDocInput list
+                       - 
+                      the components to generate documentation for
+                    
+                    
                                                            
+                    
+                      
+                        collectionName
+                      
+                      :
+                      string
+                       - 
+                      the overall collection name
+                    
+                    
                                                            
+                    
+                      
+                        substitutions
+                      
+                      :
+                      Substitutions
+                       - 
+                      the substitutions to use in content and templates
+                    
+                    
                                                            
+                    
+                      
+                        ?qualify
+                      
+                      :
+                      bool
+                       - 
+                      qualify the output set by collection name, e.g. reference/FSharp.Core/...
+                    
+                    
                                                            
+                    
+                      
+                        ?libDirs
+                      
+                      :
+                      string list
+                       - 
+                      Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                    
+                    
                                                            
+                    
+                      
+                        ?otherFlags
+                      
+                      :
+                      string list
+                       - 
+                      Additional flags that are passed to the F# compiler (you can use this if you want to
+    specify references explicitly etc.)
+                    
+                    
                                                            
+                    
+                      
+                        ?root
+                      
+                      :
+                      string
+                       - 
+                      The root url of the generated documentation within the website
+                    
+                    
                                                            
+                    
+                      
+                        ?urlRangeHighlight
+                      
+                      :
+                      Uri -> int -> int -> string
+                       - 
+                      A function that can be used to override the default way of generating GitHub links
+                    
+                    
                                                            
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                       - 
+                      
+                    
+                    
                                                            
+                    
+                      
+                        ?extension
+                      
+                      :
+                      ApiDocFileExtensions
+                       - 
+                      The extensions used for files and URLs
+                    
+                    
                                                            
+                  
                                                          
+                  
                                                          
+                  
+                    Returns: 
+                    ApiDocModel
+                  
+                  
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+                                                                    		
+            
                                                          
+              
+                
                                                          
+                  
                                                          
+                    
                                                          
+                      
+ Generates a documentation model for the assemblies specified by the `inputs` parameter
+ 
+                    
                                                          
+                  
                                                          
+                  
                                                          
+                    
+                      
+                    
+                    
                                                          
+                      
+                    
                                                          
+                    
                                                          
+                      
+                    
                                                          
+                  
                                                          
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  
+                    inputs
+                  
+                  :
+                  ApiDocInput list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the components to generate documentation for
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    collectionName
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the overall collection name
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the substitutions to use in content and templates
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?qualify
+                  
+                  :
+                  bool
+                
                                                          
+                
                                                          
+                  
                                                          
+                    qualify the output set by collection name, e.g. reference/FSharp.Core/...
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?libDirs
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?otherFlags
+                  
+                  :
+                  string list
+                
                                                          
+                
                                                          
+                  
                                                          
+                    Additional flags that are passed to the F# compiler (you can use this if you want to
+    specify references explicitly etc.)
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?root
+                  
+                  :
+                  string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    The root url of the generated documentation within the website
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?urlRangeHighlight
+                  
+                  :
+                  Uri -> int -> int -> string
+                
                                                          
+                
                                                          
+                  
                                                          
+                    A function that can be used to override the default way of generating GitHub links
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                          
+                
                                                          
+                  
                                                          
+                    
+                  
                                                          
+                
                                                          
+                
                                                          
+                  
+                    ?extension
+                  
+                  :
+                  ApiDocFileExtensions
+                
                                                          
+                
                                                          
+                  
                                                          
+                    The extensions used for files and URLs
+                  
                                                          
+                
                                                          
+              
                                                          
+              
                                                          
+                
                                                          
+                  
+                    Returns: 
+                  
+                  ApiDocModel
+                
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+          
                                                          
+            
                                                          
+              
+                
                                                          
+                  
+                    
+                      ApiDocs.SearchIndexEntriesForModel(model)
+                    
+                  
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  Full Usage: 
+                  ApiDocs.SearchIndexEntriesForModel(model)
+                  
                                                          
+                  
                                                          
+                  Parameters: 
+                  
                                                            
+                    
+                      
+                        model
+                      
+                      :
+                      ApiDocModel
+                       - 
+                      the model for documentation
+                    
+                    
                                                            
+                  
                                                          
+                  
                                                          
+                  
+                    Returns: 
+                    ApiDocsSearchIndexEntry[]
+                  
+                  
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+                                                                    		
+            
                                                          
+              
+                
                                                          
+                  
                                                          
+                    
                                                          
+                      
+ Generates the search index from the given documentation model
+ 
+                    
                                                          
+                  
                                                          
+                  
                                                          
+                    
+                      
+                    
+                    
                                                          
+                      
+                    
                                                          
+                    
                                                          
+                      
+                    
                                                          
+                  
                                                          
+                
                                                          
+                                                                        
+              
                                                          
+                
                                                          
+                  
+                    model
+                  
+                  :
+                  ApiDocModel
+                
                                                          
+                
                                                          
+                  
                                                          
+                    the model for documentation
+                  
                                                          
+                
                                                          
+              
                                                          
+              
                                                          
+                
                                                          
+                  
+                    Returns: 
+                  
+                  ApiDocsSearchIndexEntry[]
+                
                                                          
+                
                                                          
+              
                                                          
+            
                                                          
+          
                                                          
+  
                                                          
+
                                                          
+        
+    
                                                          
+
                                                          
+
+
+    
+    
                                                          
+        
                                                            
+        
                                                            Type something to start searching.
                                                            
+    
                                                            
+                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html b/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html
new file mode 100644
index 000000000..528c43efd
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidocssearchindexentry.html
@@ -0,0 +1,621 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocsSearchIndexEntry (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                            
+    
                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                            
+    
                                                            
+        
+            
+        
+        
+        
+    
                                                            
+
                                                            
+
+
                                                            
+    
                                                            
+        
                                                            
+  
                                                            
+    ApiDocsSearchIndexEntry Type
+  
                                                            
+  
                                                            
+    
                                                            
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                            
+    
                                                            
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                            
+    
                                                            
+      Base Type: 
+      obj
+    
                                                            
+    
                                                            
+      All Interfaces: 
+      IEquatable<ApiDocsSearchIndexEntry>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ApiDocsSearchIndexEntry>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                            
+  
                                                            
+  
                                                            
+    
                                                            
+      
                                                            
+        
                                                            
+           Represents an entry suitable for constructing a Lunr index
+        
                                                            
+      
                                                            
+    
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+    
                                                            
+      Record fields
+    
                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                            
+            Record Field
+          
+            Description
+            
+          
                                                            
+            
                                                            
+              
+                
                                                            
+                  
+                    
+                      content
+                    
+                  
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  Full Usage: 
+                  content
+                  
                                                            
+                  
                                                            
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+                                                                      		
+            
                                                            
+              
                                                            
+                
+                  
+                
+              
                                                            
+              
                                                            
+                
                                                            
+                  
+                    Field type: 
+                  
+                  string
+                
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+          
                                                            
+            
                                                            
+              
+                
                                                            
+                  
+                    
+                      headings
+                    
+                  
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  Full Usage: 
+                  headings
+                  
                                                            
+                  
                                                            
+                  
+                    Field type: 
+                    string list
+                  
+                  
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+                                                                      		
+            
                                                            
+              
                                                            
+                
+                  
+                
+              
                                                            
+              
                                                            
+                
                                                            
+                  
+                    Field type: 
+                  
+                  string list
+                
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+          
                                                            
+            
                                                            
+              
+                
                                                            
+                  
+                    
+                      title
+                    
+                  
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  Full Usage: 
+                  title
+                  
                                                            
+                  
                                                            
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+                                                                      		
+            
                                                            
+              
                                                            
+                
+                  
+                
+              
                                                            
+              
                                                            
+                
                                                            
+                  
+                    Field type: 
+                  
+                  string
+                
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+          
                                                            
+            
                                                            
+              
+                
                                                            
+                  
+                    
+                      type
+                    
+                  
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  Full Usage: 
+                  type
+                  
                                                            
+                  
                                                            
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+                                                                      		
+            
                                                            
+              
+                
                                                            
+                  
                                                            
+                    
                                                            
+                       apiDocs or content
+                    
                                                            
+                  
                                                            
+                  
                                                            
+                    
+                      
+                    
+                  
                                                            
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  
+                    Field type: 
+                  
+                  string
+                
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+          
                                                            
+            
                                                            
+              
+                
                                                            
+                  
+                    
+                      uri
+                    
+                  
+                
                                                            
+                                                                          
+              
                                                            
+                
                                                            
+                  Full Usage: 
+                  uri
+                  
                                                            
+                  
                                                            
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+                                                                      		
+            
                                                            
+              
                                                            
+                
+                  
+                
+              
                                                            
+              
                                                            
+                
                                                            
+                  
+                    Field type: 
+                  
+                  string
+                
                                                            
+                
                                                            
+              
                                                            
+            
                                                            
+          
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+  
                                                            
+
                                                            
+        
+    
                                                            
+
                                                            
+
+
+    
+    
                                                            
+        
                                                              
+        
                                                              Type something to start searching.
                                                              
+    
                                                              
+                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-apidoctype.html b/reference/fsharp-formatting-apidocs-apidoctype.html
new file mode 100644
index 000000000..f3f46aed0
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-apidoctype.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ApiDocType (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                              
+    
                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                              
+    
                                                              
+        
+            
+        
+        
+        
+    
                                                              
+
                                                              
+
+
                                                              
+    
                                                              
+        
                                                              
+  
                                                              
+    ApiDocType Type
+  
                                                              
+  
                                                              
+    
                                                              
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                              
+    
                                                              
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                              
+    
                                                              
+      Base Type: 
+      obj
+    
                                                              
+  
                                                              
+  
                                                              
+    
                                                              
+      
                                                              
+        
                                                              
+          
+        
                                                              
+      
                                                              
+    
                                                              
+  
                                                              
+
                                                              
+        
+    
                                                              
+
                                                              
+
+
+    
+    
                                                              
+        
                                                                
+        
                                                                Type something to start searching.
                                                                
+    
                                                                
+                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-attribute.html b/reference/fsharp-formatting-apidocs-attribute.html
new file mode 100644
index 000000000..7cbfd27ed
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-attribute.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Attribute (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                
+    
                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                
+    
                                                                
+        
+            
+        
+        
+        
+    
                                                                
+
                                                                
+
+
                                                                
+    
                                                                
+        
                                                                
+  
                                                                
+    Attribute Type
+  
                                                                
+  
                                                                
+    
                                                                
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                
+    
                                                                
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                
+    
                                                                
+      Base Type: 
+      obj
+    
                                                                
+  
                                                                
+  
                                                                
+    
                                                                
+      
                                                                
+        
                                                                
+          
+        
                                                                
+      
                                                                
+    
                                                                
+  
                                                                
+
                                                                
+        
+    
                                                                
+
                                                                
+
+
+    
+    
                                                                
+        
                                                                  
+        
                                                                  Type something to start searching.
                                                                  
+    
                                                                  
+                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-doccomment.html b/reference/fsharp-formatting-apidocs-doccomment.html
new file mode 100644
index 000000000..67c495ee2
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-doccomment.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    DocComment (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                  
+    
                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                  
+    
                                                                  
+        
+            
+        
+        
+        
+    
                                                                  
+
                                                                  
+
+
                                                                  
+    
                                                                  
+        
                                                                  
+  
                                                                  
+    DocComment Type
+  
                                                                  
+  
                                                                  
+    
                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                  
+    
                                                                  
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                  
+    
                                                                  
+      Base Type: 
+      obj
+    
                                                                  
+  
                                                                  
+  
                                                                  
+    
                                                                  
+      
                                                                  
+        
                                                                  
+          
+        
                                                                  
+      
                                                                  
+    
                                                                  
+  
                                                                  
+
                                                                  
+        
+    
                                                                  
+
                                                                  
+
+
+    
+    
                                                                  
+        
                                                                    
+        
                                                                    Type something to start searching.
                                                                    
+    
                                                                    
+                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-member.html b/reference/fsharp-formatting-apidocs-member.html
new file mode 100644
index 000000000..a235c30ce
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-member.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Member (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                    
+    
                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                    
+    
                                                                    
+        
+            
+        
+        
+        
+    
                                                                    
+
                                                                    
+
+
                                                                    
+    
                                                                    
+        
                                                                    
+  
                                                                    
+    Member Type
+  
                                                                    
+  
                                                                    
+    
                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                    
+    
                                                                    
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                    
+    
                                                                    
+      Base Type: 
+      obj
+    
                                                                    
+  
                                                                    
+  
                                                                    
+    
                                                                    
+      
                                                                    
+        
                                                                    
+          
+        
                                                                    
+      
                                                                    
+    
                                                                    
+  
                                                                    
+
                                                                    
+        
+    
                                                                    
+
                                                                    
+
+
+    
+    
                                                                    
+        
                                                                      
+        
                                                                      Type something to start searching.
                                                                      
+    
                                                                      
+                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-memberkind.html b/reference/fsharp-formatting-apidocs-memberkind.html
new file mode 100644
index 000000000..d1a4bef9d
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-memberkind.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MemberKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                      
+    
                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                      
+    
                                                                      
+        
+            
+        
+        
+        
+    
                                                                      
+
                                                                      
+
+
                                                                      
+    
                                                                      
+        
                                                                      
+  
                                                                      
+    MemberKind Type
+  
                                                                      
+  
                                                                      
+    
                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                      
+    
                                                                      
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                      
+    
                                                                      
+      Base Type: 
+      obj
+    
                                                                      
+  
                                                                      
+  
                                                                      
+    
                                                                      
+      
                                                                      
+        
                                                                      
+          
+        
                                                                      
+      
                                                                      
+    
                                                                      
+  
                                                                      
+
                                                                      
+        
+    
                                                                      
+
                                                                      
+
+
+    
+    
                                                                      
+        
                                                                        
+        
                                                                        Type something to start searching.
                                                                        
+    
                                                                        
+                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-module.html b/reference/fsharp-formatting-apidocs-module.html
new file mode 100644
index 000000000..1d5da9864
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-module.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Module (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                        
+    
                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                        
+    
                                                                        
+        
+            
+        
+        
+        
+    
                                                                        
+
                                                                        
+
+
                                                                        
+    
                                                                        
+        
                                                                        
+  
                                                                        
+    Module Type
+  
                                                                        
+  
                                                                        
+    
                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                        
+    
                                                                        
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                        
+    
                                                                        
+      Base Type: 
+      obj
+    
                                                                        
+  
                                                                        
+  
                                                                        
+    
                                                                        
+      
                                                                        
+        
                                                                        
+          
+        
                                                                        
+      
                                                                        
+    
                                                                        
+  
                                                                        
+
                                                                        
+        
+    
                                                                        
+
                                                                        
+
+
+    
+    
                                                                        
+        
                                                                          
+        
                                                                          Type something to start searching.
                                                                          
+    
                                                                          
+                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-moduleinfo.html b/reference/fsharp-formatting-apidocs-moduleinfo.html
new file mode 100644
index 000000000..ca0a278bd
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-moduleinfo.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ModuleInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                          
+    
                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                          
+    
                                                                          
+        
+            
+        
+        
+        
+    
                                                                          
+
                                                                          
+
+
                                                                          
+    
                                                                          
+        
                                                                          
+  
                                                                          
+    ModuleInfo Type
+  
                                                                          
+  
                                                                          
+    
                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                          
+    
                                                                          
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                          
+    
                                                                          
+      Base Type: 
+      obj
+    
                                                                          
+  
                                                                          
+  
                                                                          
+    
                                                                          
+      
                                                                          
+        
                                                                          
+          
+        
                                                                          
+      
                                                                          
+    
                                                                          
+  
                                                                          
+
                                                                          
+        
+    
                                                                          
+
                                                                          
+
+
+    
+    
                                                                          
+        
                                                                            
+        
                                                                            Type something to start searching.
                                                                            
+    
                                                                            
+                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-type.html b/reference/fsharp-formatting-apidocs-type.html
new file mode 100644
index 000000000..c197cd01d
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-type.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Type (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                            
+    
                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                            
+    
                                                                            
+        
+            
+        
+        
+        
+    
                                                                            
+
                                                                            
+
+
                                                                            
+    
                                                                            
+        
                                                                            
+  
                                                                            
+    Type Type
+  
                                                                            
+  
                                                                            
+    
                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                            
+    
                                                                            
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                            
+    
                                                                            
+      Base Type: 
+      obj
+    
                                                                            
+  
                                                                            
+  
                                                                            
+    
                                                                            
+      
                                                                            
+        
                                                                            
+          
+        
                                                                            
+      
                                                                            
+    
                                                                            
+  
                                                                            
+
                                                                            
+        
+    
                                                                            
+
                                                                            
+
+
+    
+    
                                                                            
+        
                                                                              
+        
                                                                              Type something to start searching.
                                                                              
+    
                                                                              
+                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs-typeinfo.html b/reference/fsharp-formatting-apidocs-typeinfo.html
new file mode 100644
index 000000000..6cb37a5d2
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs-typeinfo.html
@@ -0,0 +1,342 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TypeInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                              
+    
                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                              
+    
                                                                              
+        
+            
+        
+        
+        
+    
                                                                              
+
                                                                              
+
+
                                                                              
+    
                                                                              
+        
                                                                              
+  
                                                                              
+    TypeInfo Type
+  
                                                                              
+  
                                                                              
+    
                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.ApiDocs
+      
+    
                                                                              
+    
                                                                              
+      Assembly: FSharp.Formatting.ApiDocs.dll
+    
                                                                              
+    
                                                                              
+      Base Type: 
+      obj
+    
                                                                              
+  
                                                                              
+  
                                                                              
+    
                                                                              
+      
                                                                              
+        
                                                                              
+          
+        
                                                                              
+      
                                                                              
+    
                                                                              
+  
                                                                              
+
                                                                              
+        
+    
                                                                              
+
                                                                              
+
+
+    
+    
                                                                              
+        
                                                                                
+        
                                                                                Type something to start searching.
                                                                                
+    
                                                                                
+                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-apidocs.html b/reference/fsharp-formatting-apidocs.html
new file mode 100644
index 000000000..0200ba6d5
--- /dev/null
+++ b/reference/fsharp-formatting-apidocs.html
@@ -0,0 +1,806 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.ApiDocs | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                
+    
                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                
+    
                                                                                
+        
+            
+        
+        
+        
+    
                                                                                
+
                                                                                
+
+
                                                                                
+    
                                                                                
+        
                                                                                
+  
                                                                                
+    FSharp.Formatting.ApiDocs Namespace
+  
                                                                                
+  
                                                                                
+    
                                                                                
+      Functionality relating to generating API documentation
+    
                                                                                
+  
                                                                                
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                
+          Type
+        
+          Description
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocAttribute
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a custom attribute attached to source code
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocCollection
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a group of assemblies integrated with its associated documentation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocComment
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a documentation comment attached to source code
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocEntity
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a type definition integrated with its associated documentation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocEntityInfo
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 High-level information about a module definition
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocFileExtensions
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocHtml
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents some HTML formatted by model generation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocInput
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents an input assembly for API doc generation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocMember
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents an method, property, constructor, function or value, record field, union case or static parameter
+ integrated with its associated documentation. Includes extension members.
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocMemberDetails
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocMemberKind
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents the kind of member
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocModel
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a set of assemblies integrated with their associated documentation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocNamespace
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents a namespace integrated with its associated documentation
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocs
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                
+  This type exposes the functionality for producing documentation model from `dll` files with associated `xml` files
+  generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the `Generate` method.
+ 
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+          
                                                                                
+            
+              
+                ApiDocsSearchIndexEntry
+              
+            
+          
                                                                                
+                                                                                        		
+          
                                                                                
+            
                                                                                
+              
                                                                                
+                 Represents an entry suitable for constructing a Lunr index
+              
                                                                                
+            
                                                                                
+            
                                                                                
+              
+                
+              
+              
                                                                                
+                
+              
                                                                                
+              
                                                                                
+                
+              
                                                                                
+            
                                                                                
+          
                                                                                
+        
                                                                                
+
                                                                                
+        
+    
                                                                                
+
                                                                                
+
+
+    
+    
                                                                                
+        
                                                                                  
+        
                                                                                  Type something to start searching.
                                                                                  
+    
                                                                                  
+                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-codeformat.html b/reference/fsharp-formatting-codeformat-codeformat.html
new file mode 100644
index 000000000..78aec80ed
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-codeformat.html
@@ -0,0 +1,797 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CodeFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                  
+    
                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                  
+    
                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                  
+
                                                                                  
+
+
                                                                                  
+    
                                                                                  
+        
                                                                                  
+  
                                                                                  
+    CodeFormat Type
+  
                                                                                  
+  
                                                                                  
+    
                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                  
+    
                                                                                  
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                  
+    
                                                                                  
+      Base Type: 
+      obj
+    
                                                                                  
+  
                                                                                  
+  
                                                                                  
+    
                                                                                  
+      
                                                                                  
+        
                                                                                  
+           Exposes functionality of the F# code formatter with a nice interface
+        
                                                                                  
+      
                                                                                  
+    
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+  
                                                                                  
+    
                                                                                  
+      Static members
+    
                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                  
+            Static member
+          
+            Description
+            
+          
                                                                                  
+            
                                                                                  
+              
+                
                                                                                  
+                  
+                    
+                      CodeFormat.FormatFsx(snippets)
+                    
+                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  Full Usage: 
+                  CodeFormat.FormatFsx(snippets)
+                  
                                                                                  
+                  
                                                                                  
+                  Parameters: 
+                  
                                                                                    
+                    
+                      
+                        snippets
+                      
+                      :
+                      Snippet seq
+                    
+                    
                                                                                    
+                  
                                                                                  
+                  
                                                                                  
+                  
+                    Returns: 
+                    FormattedContent
+                  
+                  
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+                                                                                            		
+            
                                                                                  
+              
+                
                                                                                  
+                  
                                                                                  
+                    
                                                                                  
+                       Formats the .fsx snippets as iPython notebook using the default settings.
+                    
                                                                                  
+                  
                                                                                  
+                  
                                                                                  
+                    
+                      
+                    
+                    
                                                                                  
+                      
+                    
                                                                                  
+                    
                                                                                  
+                      
+                    
                                                                                  
+                  
                                                                                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  
+                    snippets
+                  
+                  :
+                  Snippet seq
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+              
                                                                                  
+                
                                                                                  
+                  
+                    Returns: 
+                  
+                  FormattedContent
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+          
                                                                                  
+            
                                                                                  
+              
+                
                                                                                  
+                  
+                    
+                      CodeFormat.FormatHtml(snippets, prefix, ?openTag, ?closeTag, ?lineNumbers, ?openLinesTag, ?closeLinesTag, ?addErrors, ?tokenKindToCss)
+                    
+                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  Full Usage: 
+                  CodeFormat.FormatHtml(snippets, prefix, ?openTag, ?closeTag, ?lineNumbers, ?openLinesTag, ?closeLinesTag, ?addErrors, ?tokenKindToCss)
+                  
                                                                                  
+                  
                                                                                  
+                  Parameters: 
+                  
                                                                                    
+                    
+                      
+                        snippets
+                      
+                      :
+                      Snippet array
+                    
+                    
                                                                                    
+                    
+                      
+                        prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?openTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?closeTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                    
+                    
+                      
+                        ?openLinesTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?closeLinesTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?addErrors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                    
+                    
+                      
+                        ?tokenKindToCss
+                      
+                      :
+                      TokenKind -> string
+                    
+                    
                                                                                    
+                  
                                                                                  
+                  
                                                                                  
+                  
+                    Returns: 
+                    FormattedContent
+                  
+                  
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+                                                                                            		
+            
                                                                                  
+              
+                
                                                                                  
+                  
                                                                                  
+                    
                                                                                  
+                       Formats the .fsx snippets as HTML. The parameters specify prefix for HTML tags, whether lines should
+ be added to outputs and whether errors should be printed.
+                    
                                                                                  
+                  
                                                                                  
+                  
                                                                                  
+                    
+                      
+                    
+                    
                                                                                  
+                      
+                    
                                                                                  
+                    
                                                                                  
+                      
+                    
                                                                                  
+                  
                                                                                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  
+                    snippets
+                  
+                  :
+                  Snippet array
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    prefix
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?openTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?closeTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?openLinesTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?closeLinesTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?addErrors
+                  
+                  :
+                  bool
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?tokenKindToCss
+                  
+                  :
+                  TokenKind -> string
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+              
                                                                                  
+                
                                                                                  
+                  
+                    Returns: 
+                  
+                  FormattedContent
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+          
                                                                                  
+            
                                                                                  
+              
+                
                                                                                  
+                  
+                    
+                      CodeFormat.FormatLatex(snippets, ?openTag, ?closeTag, ?lineNumbers)
+                    
+                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  Full Usage: 
+                  CodeFormat.FormatLatex(snippets, ?openTag, ?closeTag, ?lineNumbers)
+                  
                                                                                  
+                  
                                                                                  
+                  Parameters: 
+                  
                                                                                    
+                    
+                      
+                        snippets
+                      
+                      :
+                      Snippet array
+                    
+                    
                                                                                    
+                    
+                      
+                        ?openTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?closeTag
+                      
+                      :
+                      string
+                    
+                    
                                                                                    
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                    
+                  
                                                                                  
+                  
                                                                                  
+                  
+                    Returns: 
+                    FormattedContent
+                  
+                  
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+                                                                                            		
+            
                                                                                  
+              
+                
                                                                                  
+                  
                                                                                  
+                    
                                                                                  
+                       Formats the .fsx snippets as LaTeX. The parameters specify prefix for LaTeX tags, whether lines should
+ be added to outputs.
+                    
                                                                                  
+                  
                                                                                  
+                  
                                                                                  
+                    
+                      
+                    
+                    
                                                                                  
+                      
+                    
                                                                                  
+                    
                                                                                  
+                      
+                    
                                                                                  
+                  
                                                                                  
+                
                                                                                  
+                                                                                                
+              
                                                                                  
+                
                                                                                  
+                  
+                    snippets
+                  
+                  :
+                  Snippet array
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?openTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?closeTag
+                  
+                  :
+                  string
+                
                                                                                  
+                
                                                                                  
+                
                                                                                  
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+              
                                                                                  
+                
                                                                                  
+                  
+                    Returns: 
+                  
+                  FormattedContent
+                
                                                                                  
+                
                                                                                  
+              
                                                                                  
+            
                                                                                  
+          
                                                                                  
+  
                                                                                  
+
                                                                                  
+        
+    
                                                                                  
+
                                                                                  
+
+
+    
+    
                                                                                  
+        
                                                                                    
+        
                                                                                    Type something to start searching.
                                                                                    
+    
                                                                                    
+                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-codeformatter.html b/reference/fsharp-formatting-codeformat-codeformatter.html
new file mode 100644
index 000000000..245fccea0
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-codeformatter.html
@@ -0,0 +1,1092 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CodeFormatter (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                    
+    
                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                    
+    
                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                    
+
                                                                                    
+
+
                                                                                    
+    
                                                                                    
+        
                                                                                    
+  
                                                                                    
+    CodeFormatter Module
+  
                                                                                    
+  
                                                                                    
+    
                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                    
+    
                                                                                    
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                    
+  
                                                                                    
+  
                                                                                    
+    
                                                                                    
+      
                                                                                    
+        
                                                                                    
+           Uses agent to handle formatting requests
+        
                                                                                    
+      
                                                                                    
+    
                                                                                    
+  
                                                                                    
+  
                                                                                    
+    
                                                                                    
+      Functions and values
+    
                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                    
+            Function or value
+          
+            Description
+            
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      ParseAndCheckSource (file, source, options, defines, onError)
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  ParseAndCheckSource (file, source, options, defines, onError)
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
                                                                                      
+                    
+                      
+                        file
+                      
+                      :
+                      string
+                    
+                    
                                                                                      
+                    
+                      
+                        source
+                      
+                      :
+                      string
+                    
+                    
                                                                                      
+                    
+                      
+                        options
+                      
+                      :
+                      string option
+                    
+                    
                                                                                      
+                    
+                      
+                        defines
+                      
+                      :
+                      string option
+                    
+                    
                                                                                      
+                    
+                      
+                        onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                      
+                  
                                                                                    
+                  
                                                                                    
+                  
+                    Returns: 
+                    Snippet array * SourceError[]
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
+                
                                                                                    
+                  
                                                                                    
+                    
                                                                                    
+                       Parse, check and annotate the source code specified by 'source', assuming that it
+ is located in a specified 'file'. Optional arguments can be used
+ to give compiler command line options and preprocessor definitions
+                    
                                                                                    
+                  
                                                                                    
+                  
                                                                                    
+                    
+                      
+                    
+                    
                                                                                    
+                      
+                    
                                                                                    
+                    
                                                                                    
+                      
+                    
                                                                                    
+                  
                                                                                    
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  
+                    file
+                  
+                  :
+                  string
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    source
+                  
+                  :
+                  string
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    options
+                  
+                  :
+                  string option
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    defines
+                  
+                  :
+                  string option
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    onError
+                  
+                  :
+                  string -> unit
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  Snippet array * SourceError[]
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      categoryToTokenKind _arg1
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  categoryToTokenKind _arg1
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
+                  
                                                                                    
+                  
+                    Returns: 
+                    TokenKind option
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
                                                                                    
+                
+                  
+                
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    _arg1
+                  
+                  :
+                  SemanticClassificationType
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  TokenKind option
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      fsChecker 
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  fsChecker 
+                  
                                                                                    
+                  
                                                                                    
+                  
+                    Returns: 
+                    FSharpChecker
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
                                                                                    
+                
+                  
+                
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  FSharpChecker
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      processDoubleBackticks body
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  processDoubleBackticks body
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
                                                                                      
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                      
+                  
                                                                                    
+                  
                                                                                    
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
                                                                                    
+                
+                  
+                
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      processSnippet checkResults categorizedRanges lines snippet
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  processSnippet checkResults categorizedRanges lines snippet
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
                                                                                      
+                    
+                      
+                        checkResults
+                      
+                      :
+                      FSharpCheckFileResults
+                    
+                    
                                                                                      
+                    
+                      
+                        categorizedRanges
+                      
+                      :
+                      Map<int, 'a>
+                    
+                    
                                                                                      
+                    
+                      
+                        lines
+                      
+                      :
+                      string array
+                    
+                    
                                                                                      
+                    
+                      
+                        snippet
+                      
+                      :
+                      Snippet
+                    
+                    
                                                                                      
+                  
                                                                                    
+                  
                                                                                    
+                  
+                    Returns: 
+                    Line list
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
+                
                                                                                    
+                  
                                                                                    
+                    
                                                                                    
+                       Process snippet
+                    
                                                                                    
+                  
                                                                                    
+                  
                                                                                    
+                    
+                      
+                    
+                    
                                                                                    
+                      
+                    
                                                                                    
+                    
                                                                                    
+                      
+                    
                                                                                    
+                  
                                                                                    
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  
+                    checkResults
+                  
+                  :
+                  FSharpCheckFileResults
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    categorizedRanges
+                  
+                  :
+                  Map<int, 'a>
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    lines
+                  
+                  :
+                  string array
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    snippet
+                  
+                  :
+                  Snippet
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  Line list
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      processSnippetLine checkResults semanticRanges lines (line, lineTokens)
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  processSnippetLine checkResults semanticRanges lines (line, lineTokens)
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
+                  
                                                                                    
+                  
+                    Returns: 
+                    Line
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
                                                                                    
+                
+                  
+                
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    checkResults
+                  
+                  :
+                  FSharpCheckFileResults
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    semanticRanges
+                  
+                  :
+                  SemanticClassificationItem array
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    lines
+                  
+                  :
+                  string array
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    line
+                  
+                  :
+                  int
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    lineTokens
+                  
+                  :
+                  SnippetLine
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  Line
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+            
                                                                                    
+              
+                
                                                                                    
+                  
+                    
+                      processSourceCode (filePath, source, options, defines, onError)
+                    
+                  
+                
                                                                                    
+                                                                                                  
+              
                                                                                    
+                
                                                                                    
+                  Full Usage: 
+                  processSourceCode (filePath, source, options, defines, onError)
+                  
                                                                                    
+                  
                                                                                    
+                  Parameters: 
+                  
                                                                                      
+                    
+                      
+                        filePath
+                      
+                      :
+                      string
+                    
+                    
                                                                                      
+                    
+                      
+                        source
+                      
+                      :
+                      string
+                    
+                    
                                                                                      
+                    
+                      
+                        options
+                      
+                      :
+                      string option
+                    
+                    
                                                                                      
+                    
+                      
+                        defines
+                      
+                      :
+                      string option
+                    
+                    
                                                                                      
+                    
+                      
+                        onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                      
+                  
                                                                                    
+                  
                                                                                    
+                  
+                    Returns: 
+                    Async<Snippet array * SourceError[]>
+                  
+                  
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+                                                                                              		
+            
                                                                                    
+              
                                                                                    
+                
+                  
+                
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    filePath
+                  
+                  :
+                  string
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    source
+                  
+                  :
+                  string
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    options
+                  
+                  :
+                  string option
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    defines
+                  
+                  :
+                  string option
+                
                                                                                    
+                
                                                                                    
+                
                                                                                    
+                  
+                    onError
+                  
+                  :
+                  string -> unit
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+              
                                                                                    
+                
                                                                                    
+                  
+                    Returns: 
+                  
+                  Async<Snippet array * SourceError[]>
+                
                                                                                    
+                
                                                                                    
+              
                                                                                    
+            
                                                                                    
+          
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+  
                                                                                    
+
                                                                                    
+        
+    
                                                                                    
+
                                                                                    
+
+
+    
+    
                                                                                    
+        
                                                                                      
+        
                                                                                      Type something to start searching.
                                                                                      
+    
                                                                                      
+                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-errorkind.html b/reference/fsharp-formatting-codeformat-errorkind.html
new file mode 100644
index 000000000..df42326f5
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-errorkind.html
@@ -0,0 +1,459 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ErrorKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                      
+    
                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                      
+    
                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                      
+
                                                                                      
+
+
                                                                                      
+    
                                                                                      
+        
                                                                                      
+  
                                                                                      
+    ErrorKind Type
+  
                                                                                      
+  
                                                                                      
+    
                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                      
+    
                                                                                      
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                      
+    
                                                                                      
+      Base Type: 
+      ValueType
+    
                                                                                      
+    
                                                                                      
+      All Interfaces: 
+      IEquatable<ErrorKind>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ErrorKind>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                      
+    
                                                                                      
+      Kind: Struct
+    
                                                                                      
+  
                                                                                      
+  
                                                                                      
+    
                                                                                      
+      
                                                                                      
+        
                                                                                      
+           Represents a kind of error reported from the F# compiler (warning or error)
+        
                                                                                      
+      
                                                                                      
+    
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+    
                                                                                      
+      Union cases
+    
                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                      
+            Union case
+          
+            Description
+            
+          
                                                                                      
+            
                                                                                      
+              
+                
                                                                                      
+                  
+                    
+                      Error
+                    
+                  
+                
                                                                                      
+                                                                                                    
+              
                                                                                      
+                
                                                                                      
+                  Full Usage: 
+                  Error
+                  
                                                                                      
+                  
                                                                                      
+                
                                                                                      
+              
                                                                                      
+            
                                                                                      
+                                                                                                		
+            
                                                                                      
+              
                                                                                      
+                
                                                                                      
+                  
+                
                                                                                      
+              
                                                                                      
+              
                                                                                      
+                
+                  
+                
+              
                                                                                      
+            
                                                                                      
+          
                                                                                      
+            
                                                                                      
+              
+                
                                                                                      
+                  
+                    
+                      Warning
+                    
+                  
+                
                                                                                      
+                                                                                                    
+              
                                                                                      
+                
                                                                                      
+                  Full Usage: 
+                  Warning
+                  
                                                                                      
+                  
                                                                                      
+                
                                                                                      
+              
                                                                                      
+            
                                                                                      
+                                                                                                		
+            
                                                                                      
+              
                                                                                      
+                
                                                                                      
+                  
+                
                                                                                      
+              
                                                                                      
+              
                                                                                      
+                
+                  
+                
+              
                                                                                      
+            
                                                                                      
+          
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+  
                                                                                      
+
                                                                                      
+        
+    
                                                                                      
+
                                                                                      
+
+
+    
+    
                                                                                      
+        
                                                                                        
+        
                                                                                        Type something to start searching.
                                                                                        
+    
                                                                                        
+                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-formattedcontent.html b/reference/fsharp-formatting-codeformat-formattedcontent.html
new file mode 100644
index 000000000..dd60e72af
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-formattedcontent.html
@@ -0,0 +1,595 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FormattedContent (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                        
+    
                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                        
+    
                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                        
+
                                                                                        
+
+
                                                                                        
+    
                                                                                        
+        
                                                                                        
+  
                                                                                        
+    FormattedContent Type
+  
                                                                                        
+  
                                                                                        
+    
                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                        
+    
                                                                                        
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                        
+    
                                                                                        
+      Base Type: 
+      obj
+    
                                                                                        
+  
                                                                                        
+  
                                                                                        
+    
                                                                                        
+      
                                                                                        
+        
                                                                                        
+           Represents formatted snippets
+        
                                                                                        
+      
                                                                                        
+    
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+  
                                                                                        
+    
                                                                                        
+      Constructors
+    
                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                        
+            Constructor
+          
+            Description
+            
+          
                                                                                        
+            
                                                                                        
+              
+                
                                                                                        
+                  
+                    
+                      FormattedContent(snippets, tips)
+                    
+                  
+                
                                                                                        
+                                                                                                      
+              
                                                                                        
+                
                                                                                        
+                  Full Usage: 
+                  FormattedContent(snippets, tips)
+                  
                                                                                        
+                  
                                                                                        
+                  Parameters: 
+                  
                                                                                          
+                    
+                      
+                        snippets
+                      
+                      :
+                      FormattedSnippet array
+                    
+                    
                                                                                          
+                    
+                      
+                        tips
+                      
+                      :
+                      string
+                    
+                    
                                                                                          
+                  
                                                                                        
+                  
                                                                                        
+                  
+                    Returns: 
+                    FormattedContent
+                  
+                  
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+                                                                                                  		
+            
                                                                                        
+              
                                                                                        
+                
+                  
+                
+              
                                                                                        
+              
                                                                                        
+                
                                                                                        
+                  
+                    snippets
+                  
+                  :
+                  FormattedSnippet array
+                
                                                                                        
+                
                                                                                        
+                
                                                                                        
+                  
+                    tips
+                  
+                  :
+                  string
+                
                                                                                        
+                
                                                                                        
+              
                                                                                        
+              
                                                                                        
+                
                                                                                        
+                  
+                    Returns: 
+                  
+                  FormattedContent
+                
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+          
                                                                                        
+  
                                                                                        
+  
                                                                                        
+    
                                                                                        
+      Instance members
+    
                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                        
+            Instance member
+          
+            Description
+            
+          
                                                                                        
+            
                                                                                        
+              
+                
                                                                                        
+                  
+                    
+                      this.Snippets
+                    
+                  
+                
                                                                                        
+                                                                                                      
+              
                                                                                        
+                
                                                                                        
+                  Full Usage: 
+                  this.Snippets
+                  
                                                                                        
+                  
                                                                                        
+                  
+                    Returns: 
+                    FormattedSnippet array
+                  
+                  
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+                                                                                                  		
+            
                                                                                        
+              
+                
                                                                                        
+                  
                                                                                        
+                    
                                                                                        
+                       Returns the processed snippets as an array
+                    
                                                                                        
+                  
                                                                                        
+                  
                                                                                        
+                    
+                      
+                    
+                    
                                                                                        
+                      
+                    
                                                                                        
+                    
                                                                                        
+                      
+                    
                                                                                        
+                  
                                                                                        
+                
                                                                                        
+                                                                                                      
+              
                                                                                        
+                
                                                                                        
+                  
+                    Returns: 
+                  
+                  FormattedSnippet array
+                
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+          
                                                                                        
+            
                                                                                        
+              
+                
                                                                                        
+                  
+                    
+                      this.ToolTip
+                    
+                  
+                
                                                                                        
+                                                                                                      
+              
                                                                                        
+                
                                                                                        
+                  Full Usage: 
+                  this.ToolTip
+                  
                                                                                        
+                  
                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+                                                                                                  		
+            
                                                                                        
+              
+                
                                                                                        
+                  
                                                                                        
+                    
                                                                                        
+                       Returns string with ToolTip elements for all the snippets
+                    
                                                                                        
+                  
                                                                                        
+                  
                                                                                        
+                    
+                      
+                    
+                    
                                                                                        
+                      
+                    
                                                                                        
+                    
                                                                                        
+                      
+                    
                                                                                        
+                  
                                                                                        
+                
                                                                                        
+                                                                                                      
+              
                                                                                        
+                
                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                        
+                
                                                                                        
+              
                                                                                        
+            
                                                                                        
+          
                                                                                        
+  
                                                                                        
+  
                                                                                        
+
                                                                                        
+        
+    
                                                                                        
+
                                                                                        
+
+
+    
+    
                                                                                        
+        
                                                                                          
+        
                                                                                          Type something to start searching.
                                                                                          
+    
                                                                                          
+                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-formattedsnippet.html b/reference/fsharp-formatting-codeformat-formattedsnippet.html
new file mode 100644
index 000000000..52b033194
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-formattedsnippet.html
@@ -0,0 +1,658 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FormattedSnippet (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                          
+    
                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                          
+    
                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                          
+
                                                                                          
+
+
                                                                                          
+    
                                                                                          
+        
                                                                                          
+  
                                                                                          
+    FormattedSnippet Type
+  
                                                                                          
+  
                                                                                          
+    
                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                          
+    
                                                                                          
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                          
+    
                                                                                          
+      Base Type: 
+      obj
+    
                                                                                          
+  
                                                                                          
+  
                                                                                          
+    
                                                                                          
+      
                                                                                          
+        
                                                                                          
+          
+  Represents an individual formatted snippet with title as key
+ 
+        
                                                                                          
+      
                                                                                          
+    
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+  
                                                                                          
+    
                                                                                          
+      Constructors
+    
                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                          
+            Constructor
+          
+            Description
+            
+          
                                                                                          
+            
                                                                                          
+              
+                
                                                                                          
+                  
+                    
+                      FormattedSnippet(key, content)
+                    
+                  
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  Full Usage: 
+                  FormattedSnippet(key, content)
+                  
                                                                                          
+                  
                                                                                          
+                  Parameters: 
+                  
                                                                                            
+                    
+                      
+                        key
+                      
+                      :
+                      string
+                    
+                    
                                                                                            
+                    
+                      
+                        content
+                      
+                      :
+                      string
+                    
+                    
                                                                                            
+                  
                                                                                          
+                  
                                                                                          
+                  
+                    Returns: 
+                    FormattedSnippet
+                  
+                  
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+                                                                                                    		
+            
                                                                                          
+              
                                                                                          
+                
+                  
+                
+              
                                                                                          
+              
                                                                                          
+                
                                                                                          
+                  
+                    key
+                  
+                  :
+                  string
+                
                                                                                          
+                
                                                                                          
+                
                                                                                          
+                  
+                    content
+                  
+                  :
+                  string
+                
                                                                                          
+                
                                                                                          
+              
                                                                                          
+              
                                                                                          
+                
                                                                                          
+                  
+                    Returns: 
+                  
+                  FormattedSnippet
+                
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+          
                                                                                          
+  
                                                                                          
+  
                                                                                          
+    
                                                                                          
+      Instance members
+    
                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                          
+            Instance member
+          
+            Description
+            
+          
                                                                                          
+            
                                                                                          
+              
+                
                                                                                          
+                  
+                    
+                      this.Content
+                    
+                  
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  Full Usage: 
+                  this.Content
+                  
                                                                                          
+                  
                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+                                                                                                    		
+            
                                                                                          
+              
+                
                                                                                          
+                  
                                                                                          
+                    
                                                                                          
+                       Returns the formatted content code for the snipet
+                    
                                                                                          
+                  
                                                                                          
+                  
                                                                                          
+                    
+                      
+                    
+                    
                                                                                          
+                      
+                    
                                                                                          
+                    
                                                                                          
+                      
+                    
                                                                                          
+                  
                                                                                          
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+          
                                                                                          
+            
                                                                                          
+              
+                
                                                                                          
+                  
+                    
+                      this.Key
+                    
+                  
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  Full Usage: 
+                  this.Key
+                  
                                                                                          
+                  
                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+                                                                                                    		
+            
                                                                                          
+              
+                
                                                                                          
+                  
                                                                                          
+                    
                                                                                          
+                       Returns the key of the snippet
+                    
                                                                                          
+                  
                                                                                          
+                  
                                                                                          
+                    
+                      
+                    
+                    
                                                                                          
+                      
+                    
                                                                                          
+                    
                                                                                          
+                      
+                    
                                                                                          
+                  
                                                                                          
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+          
                                                                                          
+            
                                                                                          
+              
+                
                                                                                          
+                  
+                    
+                      this.Title
+                    
+                  
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  Full Usage: 
+                  this.Title
+                  
                                                                                          
+                  
                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+                                                                                                    		
+            
                                                                                          
+              
+                
                                                                                          
+                  
                                                                                          
+                    
                                                                                          
+                       Returns the title of the snippet
+                    
                                                                                          
+                  
                                                                                          
+                  
                                                                                          
+                    
+                      
+                    
+                    
                                                                                          
+                      
+                    
                                                                                          
+                    
                                                                                          
+                      
+                    
                                                                                          
+                  
                                                                                          
+                
                                                                                          
+                                                                                                        
+              
                                                                                          
+                
                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                          
+                
                                                                                          
+              
                                                                                          
+            
                                                                                          
+          
                                                                                          
+  
                                                                                          
+  
                                                                                          
+
                                                                                          
+        
+    
                                                                                          
+
                                                                                          
+
+
+    
+    
                                                                                          
+        
                                                                                            
+        
                                                                                            Type something to start searching.
                                                                                            
+    
                                                                                            
+                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-line.html b/reference/fsharp-formatting-codeformat-line.html
new file mode 100644
index 000000000..e5e4b85aa
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-line.html
@@ -0,0 +1,453 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Line (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                            
+    
                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                            
+    
                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                            
+
                                                                                            
+
+
                                                                                            
+    
                                                                                            
+        
                                                                                            
+  
                                                                                            
+    Line Type
+  
                                                                                            
+  
                                                                                            
+    
                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                            
+    
                                                                                            
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                            
+    
                                                                                            
+      Base Type: 
+      obj
+    
                                                                                            
+    
                                                                                            
+      All Interfaces: 
+      IEquatable<Line>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<Line>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                            
+  
                                                                                            
+  
                                                                                            
+    
                                                                                            
+      
                                                                                            
+        
                                                                                            
+           Represents a line of source code as a list of TokenSpan values. This is
+ a single case discriminated union with Line constructor.
+        
                                                                                            
+      
                                                                                            
+    
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+    
                                                                                            
+      Union cases
+    
                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                            
+            Union case
+          
+            Description
+            
+          
                                                                                            
+            
                                                                                            
+              
+                
                                                                                            
+                  
+                    
+                      Line(originalLine, tokenSpans)
+                    
+                  
+                
                                                                                            
+                                                                                                          
+              
                                                                                            
+                
                                                                                            
+                  Full Usage: 
+                  Line(originalLine, tokenSpans)
+                  
                                                                                            
+                  
                                                                                            
+                  Parameters: 
+                  
                                                                                              
+                    
+                      
+                        originalLine
+                      
+                      :
+                      string
+                    
+                    
                                                                                              
+                    
+                      
+                        tokenSpans
+                      
+                      :
+                      TokenSpans
+                    
+                    
                                                                                              
+                  
                                                                                            
+                  
                                                                                            
+                
                                                                                            
+              
                                                                                            
+            
                                                                                            
+                                                                                                      		
+            
                                                                                            
+              
                                                                                            
+                
+                  
+                
+              
                                                                                            
+              
                                                                                            
+                
                                                                                            
+                  
+                    originalLine
+                  
+                  :
+                  string
+                
                                                                                            
+                
                                                                                            
+                
                                                                                            
+                  
+                    tokenSpans
+                  
+                  :
+                  TokenSpans
+                
                                                                                            
+                
                                                                                            
+              
                                                                                            
+            
                                                                                            
+          
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+  
                                                                                            
+
                                                                                            
+        
+    
                                                                                            
+
                                                                                            
+
+
+    
+    
                                                                                            
+        
                                                                                              
+        
                                                                                              Type something to start searching.
                                                                                              
+    
                                                                                              
+                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-snippet.html b/reference/fsharp-formatting-codeformat-snippet.html
new file mode 100644
index 000000000..39d11ce8f
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-snippet.html
@@ -0,0 +1,452 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Snippet (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                              
+    
                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                              
+    
                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                              
+
                                                                                              
+
+
                                                                                              
+    
                                                                                              
+        
                                                                                              
+  
                                                                                              
+    Snippet Type
+  
                                                                                              
+  
                                                                                              
+    
                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                              
+    
                                                                                              
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                              
+    
                                                                                              
+      Base Type: 
+      obj
+    
                                                                                              
+    
                                                                                              
+      All Interfaces: 
+      IEquatable<Snippet>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<Snippet>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                              
+  
                                                                                              
+  
                                                                                              
+    
                                                                                              
+      
                                                                                              
+        
                                                                                              
+           An F# snippet consists of a snippet title and a list of lines
+        
                                                                                              
+      
                                                                                              
+    
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+    
                                                                                              
+      Union cases
+    
                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                              
+            Union case
+          
+            Description
+            
+          
                                                                                              
+            
                                                                                              
+              
+                
                                                                                              
+                  
+                    
+                      Snippet(title, lines)
+                    
+                  
+                
                                                                                              
+                                                                                                            
+              
                                                                                              
+                
                                                                                              
+                  Full Usage: 
+                  Snippet(title, lines)
+                  
                                                                                              
+                  
                                                                                              
+                  Parameters: 
+                  
                                                                                                
+                    
+                      
+                        title
+                      
+                      :
+                      string
+                    
+                    
                                                                                                
+                    
+                      
+                        lines
+                      
+                      :
+                      Line list
+                    
+                    
                                                                                                
+                  
                                                                                              
+                  
                                                                                              
+                
                                                                                              
+              
                                                                                              
+            
                                                                                              
+                                                                                                        		
+            
                                                                                              
+              
                                                                                              
+                
+                  
+                
+              
                                                                                              
+              
                                                                                              
+                
                                                                                              
+                  
+                    title
+                  
+                  :
+                  string
+                
                                                                                              
+                
                                                                                              
+                
                                                                                              
+                  
+                    lines
+                  
+                  :
+                  Line list
+                
                                                                                              
+                
                                                                                              
+              
                                                                                              
+            
                                                                                              
+          
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+  
                                                                                              
+
                                                                                              
+        
+    
                                                                                              
+
                                                                                              
+
+
+    
+    
                                                                                              
+        
                                                                                                
+        
                                                                                                Type something to start searching.
                                                                                                
+    
                                                                                                
+                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-sourceerror.html b/reference/fsharp-formatting-codeformat-sourceerror.html
new file mode 100644
index 000000000..78699e60e
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-sourceerror.html
@@ -0,0 +1,496 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    SourceError (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                
+    
                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                
+    
                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                
+
                                                                                                
+
+
                                                                                                
+    
                                                                                                
+        
                                                                                                
+  
                                                                                                
+    SourceError Type
+  
                                                                                                
+  
                                                                                                
+    
                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                
+    
                                                                                                
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                
+    
                                                                                                
+      Base Type: 
+      obj
+    
                                                                                                
+    
                                                                                                
+      All Interfaces: 
+      IEquatable<SourceError>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<SourceError>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                
+  
                                                                                                
+  
                                                                                                
+    
                                                                                                
+      
                                                                                                
+        
                                                                                                
+           Error reported from the F# compiler consists of location (start and end),
+ error kind and the message (wrapped in a single case discriminated union
+ with constructor SourceError)
+        
                                                                                                
+      
                                                                                                
+    
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+    
                                                                                                
+      Union cases
+    
                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                
+            Union case
+          
+            Description
+            
+          
                                                                                                
+            
                                                                                                
+              
+                
                                                                                                
+                  
+                    
+                      SourceError(start, finish, errorKind, message)
+                    
+                  
+                
                                                                                                
+                                                                                                              
+              
                                                                                                
+                
                                                                                                
+                  Full Usage: 
+                  SourceError(start, finish, errorKind, message)
+                  
                                                                                                
+                  
                                                                                                
+                  Parameters: 
+                  
                                                                                                  
+                    
+                      
+                        start
+                      
+                      :
+                      int * int
+                    
+                    
                                                                                                  
+                    
+                      
+                        finish
+                      
+                      :
+                      int * int
+                    
+                    
                                                                                                  
+                    
+                      
+                        errorKind
+                      
+                      :
+                      ErrorKind
+                    
+                    
                                                                                                  
+                    
+                      
+                        message
+                      
+                      :
+                      string
+                    
+                    
                                                                                                  
+                  
                                                                                                
+                  
                                                                                                
+                
                                                                                                
+              
                                                                                                
+            
                                                                                                
+                                                                                                          		
+            
                                                                                                
+              
+                
                                                                                                
+                  
                                                                                                
+                    
                                                                                                
+                       Error reported from the F# compiler consists of location (start and end),
+ error kind and the message
+                    
                                                                                                
+                  
                                                                                                
+                  
                                                                                                
+                    
+                      
+                    
+                  
                                                                                                
+                
                                                                                                
+                                                                                                              
+              
                                                                                                
+                
                                                                                                
+                  
+                    start
+                  
+                  :
+                  int * int
+                
                                                                                                
+                
                                                                                                
+                
                                                                                                
+                  
+                    finish
+                  
+                  :
+                  int * int
+                
                                                                                                
+                
                                                                                                
+                
                                                                                                
+                  
+                    errorKind
+                  
+                  :
+                  ErrorKind
+                
                                                                                                
+                
                                                                                                
+                
                                                                                                
+                  
+                    message
+                  
+                  :
+                  string
+                
                                                                                                
+                
                                                                                                
+              
                                                                                                
+            
                                                                                                
+          
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+  
                                                                                                
+
                                                                                                
+        
+    
                                                                                                
+
                                                                                                
+
+
+    
+    
                                                                                                
+        
                                                                                                  
+        
                                                                                                  Type something to start searching.
                                                                                                  
+    
                                                                                                  
+                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-tokenkind.html b/reference/fsharp-formatting-codeformat-tokenkind.html
new file mode 100644
index 000000000..6832bb665
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-tokenkind.html
@@ -0,0 +1,1273 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TokenKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                  
+    
                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                  
+    
                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                  
+
                                                                                                  
+
+
                                                                                                  
+    
                                                                                                  
+        
                                                                                                  
+  
                                                                                                  
+    TokenKind Type
+  
                                                                                                  
+  
                                                                                                  
+    
                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                  
+    
                                                                                                  
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                  
+    
                                                                                                  
+      Base Type: 
+      ValueType
+    
                                                                                                  
+    
                                                                                                  
+      All Interfaces: 
+      IEquatable<TokenKind>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<TokenKind>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                  
+    
                                                                                                  
+      Kind: Struct
+    
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+    
                                                                                                  
+      
                                                                                                  
+        
                                                                                                  
+           Classifies tokens reported by the FCS
+        
                                                                                                  
+      
                                                                                                  
+    
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+    
                                                                                                  
+      Union cases
+    
                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                  
+            Union case
+          
+            Description
+            
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Comment
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Comment
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Default
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Default
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Disposable
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Disposable
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Enumeration
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Enumeration
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Escaped
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Escaped
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Function
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Function
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Identifier
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Identifier
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Inactive
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Inactive
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Interface
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Interface
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Keyword
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Keyword
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Module
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Module
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      MutableVar
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  MutableVar
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Number
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Number
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Operator
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Operator
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Pattern
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Pattern
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Preprocessor
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Preprocessor
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Printf
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Printf
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Property
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Property
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      Punctuation
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  Punctuation
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      ReferenceType
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  ReferenceType
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      String
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  String
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      TypeArgument
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  TypeArgument
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      UnionCase
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  UnionCase
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+            
                                                                                                  
+              
+                
                                                                                                  
+                  
+                    
+                      ValueType
+                    
+                  
+                
                                                                                                  
+                                                                                                                
+              
                                                                                                  
+                
                                                                                                  
+                  Full Usage: 
+                  ValueType
+                  
                                                                                                  
+                  
                                                                                                  
+                
                                                                                                  
+              
                                                                                                  
+            
                                                                                                  
+                                                                                                            		
+            
                                                                                                  
+              
                                                                                                  
+                
                                                                                                  
+                  
+                
                                                                                                  
+              
                                                                                                  
+              
                                                                                                  
+                
+                  
+                
+              
                                                                                                  
+            
                                                                                                  
+          
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+  
                                                                                                  
+
                                                                                                  
+        
+    
                                                                                                  
+
                                                                                                  
+
+
+    
+    
                                                                                                  
+        
                                                                                                    
+        
                                                                                                    Type something to start searching.
                                                                                                    
+    
                                                                                                    
+                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-tokenspan.html b/reference/fsharp-formatting-codeformat-tokenspan.html
new file mode 100644
index 000000000..fc91527e1
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-tokenspan.html
@@ -0,0 +1,680 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TokenSpan (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                    
+    
                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                    
+    
                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                    
+
                                                                                                    
+
+
                                                                                                    
+    
                                                                                                    
+        
                                                                                                    
+  
                                                                                                    
+    TokenSpan Type
+  
                                                                                                    
+  
                                                                                                    
+    
                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                    
+    
                                                                                                    
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                    
+    
                                                                                                    
+      Base Type: 
+      obj
+    
                                                                                                    
+    
                                                                                                    
+      All Interfaces: 
+      IEquatable<TokenSpan>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<TokenSpan>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+    
                                                                                                    
+      
                                                                                                    
+        
                                                                                                    
+           A token in a parsed F# code snippet. Aside from standard tokens reported from
+ the compiler (Token), this also includes Error (wrapping the underlined
+ tokens), Omitted for the special [omit:...] tags and Output for the special [output:...] tag
+        
                                                                                                    
+      
                                                                                                    
+    
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+    
                                                                                                    
+      Union cases
+    
                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                    
+            Union case
+          
+            Description
+            
+          
                                                                                                    
+            
                                                                                                    
+              
+                
                                                                                                    
+                  
+                    
+                      Error(kind, message, body)
+                    
+                  
+                
                                                                                                    
+                                                                                                                  
+              
                                                                                                    
+                
                                                                                                    
+                  Full Usage: 
+                  Error(kind, message, body)
+                  
                                                                                                    
+                  
                                                                                                    
+                  Parameters: 
+                  
                                                                                                      
+                    
+                      
+                        kind
+                      
+                      :
+                      ErrorKind
+                    
+                    
                                                                                                      
+                    
+                      
+                        message
+                      
+                      :
+                      string
+                    
+                    
                                                                                                      
+                    
+                      
+                        body
+                      
+                      :
+                      TokenSpans
+                    
+                    
                                                                                                      
+                  
                                                                                                    
+                  
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+                                                                                                              		
+            
                                                                                                    
+              
                                                                                                    
+                
+                  
+                
+              
                                                                                                    
+              
                                                                                                    
+                
                                                                                                    
+                  
+                    kind
+                  
+                  :
+                  ErrorKind
+                
                                                                                                    
+                
                                                                                                    
+                
                                                                                                    
+                  
+                    message
+                  
+                  :
+                  string
+                
                                                                                                    
+                
                                                                                                    
+                
                                                                                                    
+                  
+                    body
+                  
+                  :
+                  TokenSpans
+                
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+          
                                                                                                    
+            
                                                                                                    
+              
+                
                                                                                                    
+                  
+                    
+                      Omitted(body, hidden)
+                    
+                  
+                
                                                                                                    
+                                                                                                                  
+              
                                                                                                    
+                
                                                                                                    
+                  Full Usage: 
+                  Omitted(body, hidden)
+                  
                                                                                                    
+                  
                                                                                                    
+                  Parameters: 
+                  
                                                                                                      
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                                      
+                    
+                      
+                        hidden
+                      
+                      :
+                      string
+                    
+                    
                                                                                                      
+                  
                                                                                                    
+                  
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+                                                                                                              		
+            
                                                                                                    
+              
                                                                                                    
+                
+                  
+                
+              
                                                                                                    
+              
                                                                                                    
+                
                                                                                                    
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                                    
+                
                                                                                                    
+                
                                                                                                    
+                  
+                    hidden
+                  
+                  :
+                  string
+                
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+          
                                                                                                    
+            
                                                                                                    
+              
+                
                                                                                                    
+                  
+                    
+                      Output string
+                    
+                  
+                
                                                                                                    
+                                                                                                                  
+              
                                                                                                    
+                
                                                                                                    
+                  Full Usage: 
+                  Output string
+                  
                                                                                                    
+                  
                                                                                                    
+                  Parameters: 
+                  
                                                                                                      
+                    
+                      
+                        Item
+                      
+                      :
+                      string
+                    
+                    
                                                                                                      
+                  
                                                                                                    
+                  
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+                                                                                                              		
+            
                                                                                                    
+              
                                                                                                    
+                
+                  
+                
+              
                                                                                                    
+              
                                                                                                    
+                
                                                                                                    
+                  
+                    Item
+                  
+                  :
+                  string
+                
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+          
                                                                                                    
+            
                                                                                                    
+              
+                
                                                                                                    
+                  
+                    
+                      Token(kind, body, tip)
+                    
+                  
+                
                                                                                                    
+                                                                                                                  
+              
                                                                                                    
+                
                                                                                                    
+                  Full Usage: 
+                  Token(kind, body, tip)
+                  
                                                                                                    
+                  
                                                                                                    
+                  Parameters: 
+                  
                                                                                                      
+                    
+                      
+                        kind
+                      
+                      :
+                      TokenKind
+                    
+                    
                                                                                                      
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                                      
+                    
+                      
+                        tip
+                      
+                      :
+                      ToolTipSpans option
+                    
+                    
                                                                                                      
+                  
                                                                                                    
+                  
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+                                                                                                              		
+            
                                                                                                    
+              
                                                                                                    
+                
+                  
+                
+              
                                                                                                    
+              
                                                                                                    
+                
                                                                                                    
+                  
+                    kind
+                  
+                  :
+                  TokenKind
+                
                                                                                                    
+                
                                                                                                    
+                
                                                                                                    
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                                    
+                
                                                                                                    
+                
                                                                                                    
+                  
+                    tip
+                  
+                  :
+                  ToolTipSpans option
+                
                                                                                                    
+                
                                                                                                    
+              
                                                                                                    
+            
                                                                                                    
+          
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+  
                                                                                                    
+
                                                                                                    
+        
+    
                                                                                                    
+
                                                                                                    
+
+
+    
+    
                                                                                                    
+        
                                                                                                      
+        
                                                                                                      Type something to start searching.
                                                                                                      
+    
                                                                                                      
+                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-tokenspans.html b/reference/fsharp-formatting-codeformat-tokenspans.html
new file mode 100644
index 000000000..e6abe9512
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-tokenspans.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TokenSpans (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                      
+    
                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                      
+    
                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                      
+
                                                                                                      
+
+
                                                                                                      
+    
                                                                                                      
+        
                                                                                                      
+  
                                                                                                      
+    TokenSpans Type
+  
                                                                                                      
+  
                                                                                                      
+    
                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                      
+    
                                                                                                      
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                      
+    
                                                                                                      
+      Abbreviation For: 
+      TokenSpan list
+    
                                                                                                      
+    
                                                                                                      
+      Base Type: 
+      obj
+    
                                                                                                      
+    
                                                                                                      
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<TokenSpan>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<TokenSpan>
+      , 
+      IReadOnlyCollection<TokenSpan>
+      , 
+      IEnumerable<TokenSpan>
+      , 
+      IEnumerable
+    
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+    
                                                                                                      
+      
                                                                                                      
+        
                                                                                                      
+           A type alias representing a list of TokenSpan values
+        
                                                                                                      
+      
                                                                                                      
+    
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+    
                                                                                                      
+      Instance members
+    
                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                      
+            Instance member
+          
+            Description
+            
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    TokenSpan
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  TokenSpan
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                      
+                  
                                                                                                      
+                  Parameters: 
+                  
                                                                                                        
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                        
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    TokenSpan
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  TokenSpan
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    TokenSpan list
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  TokenSpan list
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+  
                                                                                                      
+  
                                                                                                      
+    
                                                                                                      
+      Static members
+    
                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                      
+            Static member
+          
+            Description
+            
+          
                                                                                                      
+            
                                                                                                      
+              
+                
                                                                                                      
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                      
+                                                                                                                    
+              
                                                                                                      
+                
                                                                                                      
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                      
+                  
                                                                                                      
+                  
+                    Returns: 
+                    TokenSpan list
+                  
+                  
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+                                                                                                                		
+            
                                                                                                      
+              
                                                                                                      
+                
+                  
+                
+              
                                                                                                      
+              
                                                                                                      
+                
                                                                                                      
+                  
+                    Returns: 
+                  
+                  TokenSpan list
+                
                                                                                                      
+                
                                                                                                      
+              
                                                                                                      
+            
                                                                                                      
+          
                                                                                                      
+  
                                                                                                      
+
                                                                                                      
+        
+    
                                                                                                      
+
                                                                                                      
+
+
+    
+    
                                                                                                      
+        
                                                                                                        
+        
                                                                                                        Type something to start searching.
                                                                                                        
+    
                                                                                                        
+                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-tooltipspan.html b/reference/fsharp-formatting-codeformat-tooltipspan.html
new file mode 100644
index 000000000..b6d3aaf80
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-tooltipspan.html
@@ -0,0 +1,527 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ToolTipSpan (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                        
+    
                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                        
+    
                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                        
+
                                                                                                        
+
+
                                                                                                        
+    
                                                                                                        
+        
                                                                                                        
+  
                                                                                                        
+    ToolTipSpan Type
+  
                                                                                                        
+  
                                                                                                        
+    
                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                        
+    
                                                                                                        
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                        
+    
                                                                                                        
+      Base Type: 
+      obj
+    
                                                                                                        
+    
                                                                                                        
+      All Interfaces: 
+      IEquatable<ToolTipSpan>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ToolTipSpan>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+    
                                                                                                        
+      
                                                                                                        
+        
                                                                                                        
+           A tool tip span can be emphasized text, plain text Literal or a line brak
+        
                                                                                                        
+      
                                                                                                        
+    
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+    
                                                                                                        
+      Union cases
+    
                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                        
+            Union case
+          
+            Description
+            
+          
                                                                                                        
+            
                                                                                                        
+              
+                
                                                                                                        
+                  
+                    
+                      Emphasis ToolTipSpans
+                    
+                  
+                
                                                                                                        
+                                                                                                                      
+              
                                                                                                        
+                
                                                                                                        
+                  Full Usage: 
+                  Emphasis ToolTipSpans
+                  
                                                                                                        
+                  
                                                                                                        
+                  Parameters: 
+                  
+                  
                                                                                                        
+                
                                                                                                        
+              
                                                                                                        
+            
                                                                                                        
+                                                                                                                  		
+            
                                                                                                        
+              
                                                                                                        
+                
+                  
+                
+              
                                                                                                        
+              
                                                                                                        
+                
                                                                                                        
+                  
+                    Item
+                  
+                  :
+                  ToolTipSpans
+                
                                                                                                        
+                
                                                                                                        
+              
                                                                                                        
+            
                                                                                                        
+          
                                                                                                        
+            
                                                                                                        
+              
+                
                                                                                                        
+                  
+                    
+                      HardLineBreak
+                    
+                  
+                
                                                                                                        
+                                                                                                                      
+              
                                                                                                        
+                
                                                                                                        
+                  Full Usage: 
+                  HardLineBreak
+                  
                                                                                                        
+                  
                                                                                                        
+                
                                                                                                        
+              
                                                                                                        
+            
                                                                                                        
+                                                                                                                  		
+            
                                                                                                        
+              
                                                                                                        
+                
                                                                                                        
+                  
+                
                                                                                                        
+              
                                                                                                        
+              
                                                                                                        
+                
+                  
+                
+              
                                                                                                        
+            
                                                                                                        
+          
                                                                                                        
+            
                                                                                                        
+              
+                
                                                                                                        
+                  
+                    
+                      Literal string
+                    
+                  
+                
                                                                                                        
+                                                                                                                      
+              
                                                                                                        
+                
                                                                                                        
+                  Full Usage: 
+                  Literal string
+                  
                                                                                                        
+                  
                                                                                                        
+                  Parameters: 
+                  
                                                                                                          
+                    
+                      
+                        Item
+                      
+                      :
+                      string
+                    
+                    
                                                                                                          
+                  
                                                                                                        
+                  
                                                                                                        
+                
                                                                                                        
+              
                                                                                                        
+            
                                                                                                        
+                                                                                                                  		
+            
                                                                                                        
+              
                                                                                                        
+                
+                  
+                
+              
                                                                                                        
+              
                                                                                                        
+                
                                                                                                        
+                  
+                    Item
+                  
+                  :
+                  string
+                
                                                                                                        
+                
                                                                                                        
+              
                                                                                                        
+            
                                                                                                        
+          
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+  
                                                                                                        
+
                                                                                                        
+        
+    
                                                                                                        
+
                                                                                                        
+
+
+    
+    
                                                                                                        
+        
                                                                                                          
+        
                                                                                                          Type something to start searching.
                                                                                                          
+    
                                                                                                          
+                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat-tooltipspans.html b/reference/fsharp-formatting-codeformat-tooltipspans.html
new file mode 100644
index 000000000..8244714cf
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat-tooltipspans.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ToolTipSpans (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                          
+    
                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                          
+    
                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                          
+
                                                                                                          
+
+
                                                                                                          
+    
                                                                                                          
+        
                                                                                                          
+  
                                                                                                          
+    ToolTipSpans Type
+  
                                                                                                          
+  
                                                                                                          
+    
                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.CodeFormat
+      
+    
                                                                                                          
+    
                                                                                                          
+      Assembly: FSharp.Formatting.CodeFormat.dll
+    
                                                                                                          
+    
                                                                                                          
+      Abbreviation For: 
+      ToolTipSpan list
+    
                                                                                                          
+    
                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                          
+    
                                                                                                          
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<ToolTipSpan>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<ToolTipSpan>
+      , 
+      IReadOnlyCollection<ToolTipSpan>
+      , 
+      IEnumerable<ToolTipSpan>
+      , 
+      IEnumerable
+    
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+    
                                                                                                          
+      
                                                                                                          
+        
                                                                                                          
+           A tool tip consists of a list of items reported from the compiler
+        
                                                                                                          
+      
                                                                                                          
+    
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+    
                                                                                                          
+      Instance members
+    
                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                          
+            Instance member
+          
+            Description
+            
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    ToolTipSpan
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  ToolTipSpan
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                          
+                  
                                                                                                          
+                  Parameters: 
+                  
                                                                                                            
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                            
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    ToolTipSpan
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  ToolTipSpan
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    ToolTipSpan list
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  ToolTipSpan list
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+  
                                                                                                          
+  
                                                                                                          
+    
                                                                                                          
+      Static members
+    
                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                          
+            Static member
+          
+            Description
+            
+          
                                                                                                          
+            
                                                                                                          
+              
+                
                                                                                                          
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                          
+                                                                                                                        
+              
                                                                                                          
+                
                                                                                                          
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                          
+                  
                                                                                                          
+                  
+                    Returns: 
+                    ToolTipSpan list
+                  
+                  
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+                                                                                                                    		
+            
                                                                                                          
+              
                                                                                                          
+                
+                  
+                
+              
                                                                                                          
+              
                                                                                                          
+                
                                                                                                          
+                  
+                    Returns: 
+                  
+                  ToolTipSpan list
+                
                                                                                                          
+                
                                                                                                          
+              
                                                                                                          
+            
                                                                                                          
+          
                                                                                                          
+  
                                                                                                          
+
                                                                                                          
+        
+    
                                                                                                          
+
                                                                                                          
+
+
+    
+    
                                                                                                          
+        
                                                                                                            
+        
                                                                                                            Type something to start searching.
                                                                                                            
+    
                                                                                                            
+                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-codeformat.html b/reference/fsharp-formatting-codeformat.html
new file mode 100644
index 000000000..e91ca0236
--- /dev/null
+++ b/reference/fsharp-formatting-codeformat.html
@@ -0,0 +1,747 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.CodeFormat | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                            
+    
                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                            
+    
                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                            
+
                                                                                                            
+
+
                                                                                                            
+    
                                                                                                            
+        
                                                                                                            
+  
                                                                                                            
+    FSharp.Formatting.CodeFormat Namespace
+  
                                                                                                            
+  
                                                                                                            
+    
                                                                                                            
+      Functionality relating to formatting F# scripts and code snippets
+    
                                                                                                            
+  
                                                                                                            
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                            
+          Type/Module
+        
+          Description
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                CodeFormat
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Exposes functionality of the F# code formatter with a nice interface
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                CodeFormatter
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Uses agent to handle formatting requests
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                ErrorKind
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Represents a kind of error reported from the F# compiler (warning or error)
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                FormattedContent
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Represents formatted snippets
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                FormattedSnippet
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                
+  Represents an individual formatted snippet with title as key
+ 
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                Line
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Represents a line of source code as a list of TokenSpan values. This is
+ a single case discriminated union with Line constructor.
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                Snippet
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 An F# snippet consists of a snippet title and a list of lines
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                SourceError
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Error reported from the F# compiler consists of location (start and end),
+ error kind and the message (wrapped in a single case discriminated union
+ with constructor SourceError)
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                TokenKind
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 Classifies tokens reported by the FCS
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                TokenSpan
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 A token in a parsed F# code snippet. Aside from standard tokens reported from
+ the compiler (Token), this also includes Error (wrapping the underlined
+ tokens), Omitted for the special [omit:...] tags and Output for the special [output:...] tag
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                TokenSpans
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 A type alias representing a list of TokenSpan values
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                ToolTipSpan
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 A tool tip span can be emphasized text, plain text Literal or a line brak
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+          
                                                                                                            
+            
+              
+                ToolTipSpans
+              
+            
+          
                                                                                                            
+                                                                                                                    		
+          
                                                                                                            
+            
                                                                                                            
+              
                                                                                                            
+                 A tool tip consists of a list of items reported from the compiler
+              
                                                                                                            
+            
                                                                                                            
+            
                                                                                                            
+              
+                
+              
+              
                                                                                                            
+                
+              
                                                                                                            
+              
                                                                                                            
+                
+              
                                                                                                            
+            
                                                                                                            
+          
                                                                                                            
+        
                                                                                                            
+
                                                                                                            
+        
+    
                                                                                                            
+
                                                                                                            
+
+
+    
+    
                                                                                                            
+        
                                                                                                              
+        
                                                                                                              Type something to start searching.
                                                                                                              
+    
                                                                                                              
+                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-common-menu-menuitem.html b/reference/fsharp-formatting-common-menu-menuitem.html
new file mode 100644
index 000000000..3570583a6
--- /dev/null
+++ b/reference/fsharp-formatting-common-menu-menuitem.html
@@ -0,0 +1,526 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MenuItem (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                              
+    
                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                              
+    
                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                              
+
                                                                                                              
+
+
                                                                                                              
+    
                                                                                                              
+        
                                                                                                              
+  
                                                                                                              
+    MenuItem Type
+  
                                                                                                              
+  
                                                                                                              
+    
                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Common
+      
+    
                                                                                                              
+    
                                                                                                              
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                              
+    
                                                                                                              
+      Parent Module: 
+      
+        Menu
+      
+    
                                                                                                              
+    
                                                                                                              
+      Base Type: 
+      obj
+    
                                                                                                              
+    
                                                                                                              
+      All Interfaces: 
+      IEquatable<MenuItem>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<MenuItem>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+    
                                                                                                              
+      
                                                                                                              
+        
                                                                                                              
+          
+        
                                                                                                              
+      
                                                                                                              
+    
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+    
                                                                                                              
+      Record fields
+    
                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                              
+            Record Field
+          
+            Description
+            
+          
                                                                                                              
+            
                                                                                                              
+              
+                
                                                                                                              
+                  
+                    
+                      Content
+                    
+                  
+                
                                                                                                              
+                                                                                                                            
+              
                                                                                                              
+                
                                                                                                              
+                  Full Usage: 
+                  Content
+                  
                                                                                                              
+                  
                                                                                                              
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+                                                                                                                        		
+            
                                                                                                              
+              
                                                                                                              
+                
+                  
+                
+              
                                                                                                              
+              
                                                                                                              
+                
                                                                                                              
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+          
                                                                                                              
+            
                                                                                                              
+              
+                
                                                                                                              
+                  
+                    
+                      IsActive
+                    
+                  
+                
                                                                                                              
+                                                                                                                            
+              
                                                                                                              
+                
                                                                                                              
+                  Full Usage: 
+                  IsActive
+                  
                                                                                                              
+                  
                                                                                                              
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+                                                                                                                        		
+            
                                                                                                              
+              
                                                                                                              
+                
+                  
+                
+              
                                                                                                              
+              
                                                                                                              
+                
                                                                                                              
+                  
+                    Field type: 
+                  
+                  bool
+                
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+          
                                                                                                              
+            
                                                                                                              
+              
+                
                                                                                                              
+                  
+                    
+                      Link
+                    
+                  
+                
                                                                                                              
+                                                                                                                            
+              
                                                                                                              
+                
                                                                                                              
+                  Full Usage: 
+                  Link
+                  
                                                                                                              
+                  
                                                                                                              
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+                                                                                                                        		
+            
                                                                                                              
+              
                                                                                                              
+                
+                  
+                
+              
                                                                                                              
+              
                                                                                                              
+                
                                                                                                              
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                              
+                
                                                                                                              
+              
                                                                                                              
+            
                                                                                                              
+          
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+  
                                                                                                              
+
                                                                                                              
+        
+    
                                                                                                              
+
                                                                                                              
+
+
+    
+    
                                                                                                              
+        
                                                                                                                
+        
                                                                                                                Type something to start searching.
                                                                                                                
+    
                                                                                                                
+                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-common-menu.html b/reference/fsharp-formatting-common-menu.html
new file mode 100644
index 000000000..f4684c04f
--- /dev/null
+++ b/reference/fsharp-formatting-common-menu.html
@@ -0,0 +1,668 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Menu (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                
+    
                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                
+    
                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                
+
                                                                                                                
+
+
                                                                                                                
+    
                                                                                                                
+        
                                                                                                                
+  
                                                                                                                
+    Menu Module
+  
                                                                                                                
+  
                                                                                                                
+    
                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Common
+      
+    
                                                                                                                
+    
                                                                                                                
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+    
                                                                                                                
+      
                                                                                                                
+        
                                                                                                                
+          
+        
                                                                                                                
+      
                                                                                                                
+    
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+    
                                                                                                                
+      Types
+    
                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                
+            Type
+          
+            Description
+          
                                                                                                                
+            
                                                                                                                
+              
+                
+                  MenuItem
+                
+              
+            
                                                                                                                
+                                                                                                                          		
+            
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                
                                                                                                                
+              
                                                                                                                
+              
                                                                                                                
+                
+                  
+                
+                
                                                                                                                
+                  
+                
                                                                                                                
+                
                                                                                                                
+                  
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+          
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+    
                                                                                                                
+      Functions and values
+    
                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                
+            Function or value
+          
+            Description
+            
+          
                                                                                                                
+            
                                                                                                                
+              
+                
                                                                                                                
+                  
+                    
+                      createMenu input isCategoryActive header items
+                    
+                  
+                
                                                                                                                
+                                                                                                                              
+              
                                                                                                                
+                
                                                                                                                
+                  Full Usage: 
+                  createMenu input isCategoryActive header items
+                  
                                                                                                                
+                  
                                                                                                                
+                  Parameters: 
+                  
                                                                                                                  
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                  
+                    
+                      
+                        isCategoryActive
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                  
+                    
+                      
+                        header
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                  
+                    
+                      
+                        items
+                      
+                      :
+                      MenuItem list
+                    
+                    
                                                                                                                  
+                  
                                                                                                                
+                  
                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+                                                                                                                          		
+            
                                                                                                                
+              
                                                                                                                
+                
+                  
+                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                
+                
                                                                                                                
+                
                                                                                                                
+                  
+                    isCategoryActive
+                  
+                  :
+                  bool
+                
                                                                                                                
+                
                                                                                                                
+                
                                                                                                                
+                  
+                    header
+                  
+                  :
+                  string
+                
                                                                                                                
+                
                                                                                                                
+                
                                                                                                                
+                  
+                    items
+                  
+                  :
+                  MenuItem list
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+          
                                                                                                                
+            
                                                                                                                
+              
+                
                                                                                                                
+                  
+                    
+                      getLastWriteTimes input
+                    
+                  
+                
                                                                                                                
+                                                                                                                              
+              
                                                                                                                
+                
                                                                                                                
+                  Full Usage: 
+                  getLastWriteTimes input
+                  
                                                                                                                
+                  
                                                                                                                
+                  Parameters: 
+                  
                                                                                                                  
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                  
+                  
                                                                                                                
+                  
                                                                                                                
+                  
+                    Returns: 
+                    DateTime list
+                  
+                  
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+                                                                                                                          		
+            
                                                                                                                
+              
                                                                                                                
+                
+                  
+                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    Returns: 
+                  
+                  DateTime list
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+          
                                                                                                                
+            
                                                                                                                
+              
+                
                                                                                                                
+                  
+                    
+                      isTemplatingAvailable input
+                    
+                  
+                
                                                                                                                
+                                                                                                                              
+              
                                                                                                                
+                
                                                                                                                
+                  Full Usage: 
+                  isTemplatingAvailable input
+                  
                                                                                                                
+                  
                                                                                                                
+                  Parameters: 
+                  
                                                                                                                  
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                  
+                  
                                                                                                                
+                  
                                                                                                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+                                                                                                                          		
+            
                                                                                                                
+              
                                                                                                                
+                
+                  
+                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+              
                                                                                                                
+                
                                                                                                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                
+                
                                                                                                                
+              
                                                                                                                
+            
                                                                                                                
+          
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+  
                                                                                                                
+
                                                                                                                
+        
+    
                                                                                                                
+
                                                                                                                
+
+
+    
+    
                                                                                                                
+        
                                                                                                                  
+        
                                                                                                                  Type something to start searching.
                                                                                                                  
+    
                                                                                                                  
+                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-common-pagecontentlist.html b/reference/fsharp-formatting-common-pagecontentlist.html
new file mode 100644
index 000000000..dee1b3974
--- /dev/null
+++ b/reference/fsharp-formatting-common-pagecontentlist.html
@@ -0,0 +1,497 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    PageContentList (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                  
+    
                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                  
+    
                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                  
+
                                                                                                                  
+
+
                                                                                                                  
+    
                                                                                                                  
+        
                                                                                                                  
+  
                                                                                                                  
+    PageContentList Module
+  
                                                                                                                  
+  
                                                                                                                  
+    
                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Common
+      
+    
                                                                                                                  
+    
                                                                                                                  
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+    
                                                                                                                  
+      
                                                                                                                  
+        
                                                                                                                  
+          
+        
                                                                                                                  
+      
                                                                                                                  
+    
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+    
                                                                                                                  
+      Functions and values
+    
                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                  
+            Function or value
+          
+            Description
+            
+          
                                                                                                                  
+            
                                                                                                                  
+              
+                
                                                                                                                  
+                  
+                    
+                      EmptyContent 
+                    
+                  
+                
                                                                                                                  
+                                                                                                                                
+              
                                                                                                                  
+                
                                                                                                                  
+                  Full Usage: 
+                  EmptyContent 
+                  
                                                                                                                  
+                  
                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                  
+                
                                                                                                                  
+              
                                                                                                                  
+            
                                                                                                                  
+                                                                                                                            		
+            
                                                                                                                  
+              
                                                                                                                  
+                
+                  
+                
+              
                                                                                                                  
+              
                                                                                                                  
+                
                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                  
+                
                                                                                                                  
+              
                                                                                                                  
+            
                                                                                                                  
+          
                                                                                                                  
+            
                                                                                                                  
+              
+                
                                                                                                                  
+                  
+                    
+                      mkPageContentMenu html
+                    
+                  
+                
                                                                                                                  
+                                                                                                                                
+              
                                                                                                                  
+                
                                                                                                                  
+                  Full Usage: 
+                  mkPageContentMenu html
+                  
                                                                                                                  
+                  
                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                    
+                    
+                      
+                        html
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                    
+                  
                                                                                                                  
+                  
                                                                                                                  
+                  
+                    Returns: 
+                    string list * string
+                  
+                  
                                                                                                                  
+                
                                                                                                                  
+              
                                                                                                                  
+            
                                                                                                                  
+                                                                                                                            		
+            
                                                                                                                  
+              
+                
                                                                                                                  
+                  
                                                                                                                  
+                    
                                                                                                                  
+                       We process the html to collect the table of content.
+ We can't use the doc.MarkdownDocument because we cannot easily get the generated id values.
+ It is safer to parse the html.
+                    
                                                                                                                  
+                  
                                                                                                                  
+                  
                                                                                                                  
+                    
+                      
+                    
+                    
                                                                                                                  
+                      
+                    
                                                                                                                  
+                    
                                                                                                                  
+                      
+                    
                                                                                                                  
+                  
                                                                                                                  
+                
                                                                                                                  
+                                                                                                                                
+              
                                                                                                                  
+                
                                                                                                                  
+                  
+                    html
+                  
+                  :
+                  string
+                
                                                                                                                  
+                
                                                                                                                  
+              
                                                                                                                  
+              
                                                                                                                  
+                
                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string list * string
+                
                                                                                                                  
+                
                                                                                                                  
+              
                                                                                                                  
+            
                                                                                                                  
+          
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+  
                                                                                                                  
+
                                                                                                                  
+        
+    
                                                                                                                  
+
                                                                                                                  
+
+
+    
+    
                                                                                                                  
+        
                                                                                                                    
+        
                                                                                                                    Type something to start searching.
                                                                                                                    
+    
                                                                                                                    
+                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-common.html b/reference/fsharp-formatting-common.html
new file mode 100644
index 000000000..ff5fbf319
--- /dev/null
+++ b/reference/fsharp-formatting-common.html
@@ -0,0 +1,395 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.Common | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                    
+    
                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                    
+    
                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                    
+
                                                                                                                    
+
+
                                                                                                                    
+    
                                                                                                                    
+        
                                                                                                                    
+  
                                                                                                                    
+    FSharp.Formatting.Common Namespace
+  
                                                                                                                    
+  
                                                                                                                    
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                    
+          Modules
+        
+          Description
+        
                                                                                                                    
+          
                                                                                                                    
+            
+              
+                Menu
+              
+            
+          
                                                                                                                    
+                                                                                                                            		
+          
                                                                                                                    
+            
                                                                                                                    
+              
                                                                                                                    
+                
+              
                                                                                                                    
+            
                                                                                                                    
+            
                                                                                                                    
+              
+                
+              
+              
                                                                                                                    
+                
+              
                                                                                                                    
+              
                                                                                                                    
+                
+              
                                                                                                                    
+            
                                                                                                                    
+          
                                                                                                                    
+        
                                                                                                                    
+          
                                                                                                                    
+            
+              
+                PageContentList
+              
+            
+          
                                                                                                                    
+                                                                                                                            		
+          
                                                                                                                    
+            
                                                                                                                    
+              
                                                                                                                    
+                
+              
                                                                                                                    
+            
                                                                                                                    
+            
                                                                                                                    
+              
+                
+              
+              
                                                                                                                    
+                
+              
                                                                                                                    
+              
                                                                                                                    
+                
+              
                                                                                                                    
+            
                                                                                                                    
+          
                                                                                                                    
+        
                                                                                                                    
+
                                                                                                                    
+        
+    
                                                                                                                    
+
                                                                                                                    
+
+
+    
+    
                                                                                                                    
+        
                                                                                                                      
+        
                                                                                                                      Type something to start searching.
                                                                                                                      
+    
                                                                                                                      
+                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-clikeformat.html b/reference/fsharp-formatting-csharpformat-clikeformat.html
new file mode 100644
index 000000000..785682fe0
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-clikeformat.html
@@ -0,0 +1,554 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CLikeFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                      
+    
                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                      
+    
                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                      
+
                                                                                                                      
+
+
                                                                                                                      
+    
                                                                                                                      
+        
                                                                                                                      
+  
                                                                                                                      
+    CLikeFormat Type
+  
                                                                                                                      
+  
                                                                                                                      
+    
                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                      
+    
                                                                                                                      
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                      
+    
                                                                                                                      
+      Base Type: 
+      CodeFormat
+    
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+    
                                                                                                                      
+      
                                                                                                                      
+        
                                                                                                                      
+          
+             Provides a base class for formatting languages similar to C.
+             
+        
                                                                                                                      
+      
                                                                                                                      
+    
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+    
                                                                                                                      
+      Constructors
+    
                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                      
+            Constructor
+          
+            Description
+            
+          
                                                                                                                      
+            
                                                                                                                      
+              
+                
                                                                                                                      
+                  
+                    
+                      CLikeFormat()
+                    
+                  
+                
                                                                                                                      
+                                                                                                                                    
+              
                                                                                                                      
+                
                                                                                                                      
+                  Full Usage: 
+                  CLikeFormat()
+                  
                                                                                                                      
+                  
                                                                                                                      
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+                                                                                                                                		
+            
                                                                                                                      
+              
                                                                                                                      
+                
                                                                                                                      
+                  
+                
                                                                                                                      
+              
                                                                                                                      
+              
                                                                                                                      
+                
                                                                                                                      
+                  
+                
                                                                                                                      
+                
                                                                                                                      
+                  
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+          
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+    
                                                                                                                      
+      Instance members
+    
                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                      
+            Instance member
+          
+            Description
+            
+          
                                                                                                                      
+            
                                                                                                                      
+              
+                
                                                                                                                      
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                      
+                                                                                                                                    
+              
                                                                                                                      
+                
                                                                                                                      
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                      
+                  
                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                      
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+                                                                                                                                		
+            
                                                                                                                      
+              
+                
                                                                                                                      
+                  
                                                                                                                      
+                    
                                                                                                                      
+                                  Regular expression string to match single line and multi-line 
+            comments (// and /* */).
+                    
                                                                                                                      
+                  
                                                                                                                      
+                  
                                                                                                                      
+                    
                                                                                                                      
+                      
+                    
                                                                                                                      
+                    
                                                                                                                      
+                      
+                    
                                                                                                                      
+                  
                                                                                                                      
+                
                                                                                                                      
+                                                                                                                                    
+              
                                                                                                                      
+                
                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                      
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+          
                                                                                                                      
+            
                                                                                                                      
+              
+                
                                                                                                                      
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                      
+                                                                                                                                    
+              
                                                                                                                      
+                
                                                                                                                      
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                      
+                  
                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                      
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+                                                                                                                                		
+            
                                                                                                                      
+              
+                
                                                                                                                      
+                  
                                                                                                                      
+                    
                                                                                                                      
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                      
+                  
                                                                                                                      
+                  
                                                                                                                      
+                    
                                                                                                                      
+                      
+                    
                                                                                                                      
+                    
                                                                                                                      
+                      
+                    
                                                                                                                      
+                  
                                                                                                                      
+                
                                                                                                                      
+                                                                                                                                    
+              
                                                                                                                      
+                
                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                      
+                
                                                                                                                      
+              
                                                                                                                      
+            
                                                                                                                      
+          
                                                                                                                      
+  
                                                                                                                      
+  
                                                                                                                      
+
                                                                                                                      
+        
+    
                                                                                                                      
+
                                                                                                                      
+
+
+    
+    
                                                                                                                      
+        
                                                                                                                        
+        
                                                                                                                        Type something to start searching.
                                                                                                                        
+    
                                                                                                                        
+                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-codeformat.html b/reference/fsharp-formatting-csharpformat-codeformat.html
new file mode 100644
index 000000000..46c33681b
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-codeformat.html
@@ -0,0 +1,886 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CodeFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                        
+    
                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                        
+    
                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                        
+
                                                                                                                        
+
+
                                                                                                                        
+    
                                                                                                                        
+        
                                                                                                                        
+  
                                                                                                                        
+    CodeFormat Type
+  
                                                                                                                        
+  
                                                                                                                        
+    
                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                        
+    
                                                                                                                        
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                        
+    
                                                                                                                        
+      Base Type: 
+      SourceFormat
+    
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+    
                                                                                                                        
+      
                                                                                                                        
+        
                                                                                                                        
+                      Provides a base class for formatting most programming languages.
+        
                                                                                                                        
+      
                                                                                                                        
+    
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+    
                                                                                                                        
+      Constructors
+    
                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                        
+            Constructor
+          
+            Description
+            
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      CodeFormat()
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  CodeFormat()
+                  
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
                                                                                                                        
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                
                                                                                                                        
+                
                                                                                                                        
+                  
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+    
                                                                                                                        
+      Instance members
+    
                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                        
+            Instance member
+          
+            Description
+            
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.CaseSensitive
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.CaseSensitive
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+            Determines if the language is case sensitive.
+            
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
+            A case-insensitive language formatter must override this 
+            property to return false.
+            
+              
                                                                                                                        
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                                  Must be overridden to provide a regular expression string
+            to match comments.
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+            Must be overridden to provide a list of keywords defined in 
+            each language.
+            
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
+            Keywords must be separated with spaces.
+            
+              
                                                                                                                        
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.NumberRegEx
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.NumberRegEx
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                                  Can be overridden to provide a list of tokes to be recognized as numbers.
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.Operators
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.Operators
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+            Must be overridden to provide a list of operators defined in 
+            each language.
+            
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
+            Operators must be separated with spaces.
+            
+              
                                                                                                                        
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+            Can be overridden to provide a list of preprocessors defined in 
+            each language.
+            
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
+            Preprocessors must be separated with spaces.
+            
+              
                                                                                                                        
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                        
+                  
                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+                                                                                                                                  		
+            
                                                                                                                        
+              
+                
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                                  Must be overridden to provide a regular expression string
+            to match strings literals.
+                    
                                                                                                                        
+                  
                                                                                                                        
+                  
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                    
                                                                                                                        
+                      
+                    
                                                                                                                        
+                  
                                                                                                                        
+                
                                                                                                                        
+                                                                                                                                      
+              
                                                                                                                        
+                
                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                        
+                
                                                                                                                        
+              
                                                                                                                        
+            
                                                                                                                        
+          
                                                                                                                        
+  
                                                                                                                        
+  
                                                                                                                        
+
                                                                                                                        
+        
+    
                                                                                                                        
+
                                                                                                                        
+
+
+    
+    
                                                                                                                        
+        
                                                                                                                          
+        
                                                                                                                          Type something to start searching.
                                                                                                                          
+    
                                                                                                                          
+                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-cplusplusformat.html b/reference/fsharp-formatting-csharpformat-cplusplusformat.html
new file mode 100644
index 000000000..65bbc7a8d
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-cplusplusformat.html
@@ -0,0 +1,551 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CPlusPlusFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                          
+    
                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                          
+    
                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                          
+
                                                                                                                          
+
+
                                                                                                                          
+    
                                                                                                                          
+        
                                                                                                                          
+  
                                                                                                                          
+    CPlusPlusFormat Type
+  
                                                                                                                          
+  
                                                                                                                          
+    
                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                          
+    
                                                                                                                          
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                          
+    
                                                                                                                          
+      Base Type: 
+      CLikeFormat
+    
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+    
                                                                                                                          
+      
                                                                                                                          
+        
                                                                                                                          
+                      Generates color-coded HTML 4.01 from C++ source code.
+        
                                                                                                                          
+      
                                                                                                                          
+    
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+    
                                                                                                                          
+      Constructors
+    
                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                          
+            Constructor
+          
+            Description
+            
+          
                                                                                                                          
+            
                                                                                                                          
+              
+                
                                                                                                                          
+                  
+                    
+                      CPlusPlusFormat()
+                    
+                  
+                
                                                                                                                          
+                                                                                                                                        
+              
                                                                                                                          
+                
                                                                                                                          
+                  Full Usage: 
+                  CPlusPlusFormat()
+                  
                                                                                                                          
+                  
                                                                                                                          
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+                                                                                                                                    		
+            
                                                                                                                          
+              
                                                                                                                          
+                
                                                                                                                          
+                  
+                
                                                                                                                          
+              
                                                                                                                          
+              
                                                                                                                          
+                
                                                                                                                          
+                  
+                
                                                                                                                          
+                
                                                                                                                          
+                  
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+          
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+    
                                                                                                                          
+      Instance members
+    
                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                          
+            Instance member
+          
+            Description
+            
+          
                                                                                                                          
+            
                                                                                                                          
+              
+                
                                                                                                                          
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                          
+                                                                                                                                        
+              
                                                                                                                          
+                
                                                                                                                          
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                          
+                  
                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                          
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                          
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+                                                                                                                                    		
+            
                                                                                                                          
+              
+                
                                                                                                                          
+                  
                                                                                                                          
+                    
                                                                                                                          
+                                  The list of C++ keywords.
+                    
                                                                                                                          
+                  
                                                                                                                          
+                  
                                                                                                                          
+                    
                                                                                                                          
+                      
+                    
                                                                                                                          
+                    
                                                                                                                          
+                      
+                    
                                                                                                                          
+                  
                                                                                                                          
+                
                                                                                                                          
+                                                                                                                                        
+              
                                                                                                                          
+                
                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                          
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+          
                                                                                                                          
+            
                                                                                                                          
+              
+                
                                                                                                                          
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                          
+                                                                                                                                        
+              
                                                                                                                          
+                
                                                                                                                          
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                          
+                  
                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                          
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                          
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+                                                                                                                                    		
+            
                                                                                                                          
+              
+                
                                                                                                                          
+                  
                                                                                                                          
+                    
                                                                                                                          
+                                  The list of C++ preprocessors.
+                    
                                                                                                                          
+                  
                                                                                                                          
+                  
                                                                                                                          
+                    
                                                                                                                          
+                      
+                    
                                                                                                                          
+                    
                                                                                                                          
+                      
+                    
                                                                                                                          
+                  
                                                                                                                          
+                
                                                                                                                          
+                                                                                                                                        
+              
                                                                                                                          
+                
                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                          
+                
                                                                                                                          
+              
                                                                                                                          
+            
                                                                                                                          
+          
                                                                                                                          
+  
                                                                                                                          
+  
                                                                                                                          
+
                                                                                                                          
+        
+    
                                                                                                                          
+
                                                                                                                          
+
+
+    
+    
                                                                                                                          
+        
                                                                                                                            
+        
                                                                                                                            Type something to start searching.
                                                                                                                            
+    
                                                                                                                            
+                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-csharpformat.html b/reference/fsharp-formatting-csharpformat-csharpformat.html
new file mode 100644
index 000000000..e2297a292
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-csharpformat.html
@@ -0,0 +1,612 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    CSharpFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                            
+    
                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                            
+    
                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                            
+
                                                                                                                            
+
+
                                                                                                                            
+    
                                                                                                                            
+        
                                                                                                                            
+  
                                                                                                                            
+    CSharpFormat Type
+  
                                                                                                                            
+  
                                                                                                                            
+    
                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                            
+    
                                                                                                                            
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                            
+    
                                                                                                                            
+      Base Type: 
+      CLikeFormat
+    
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+    
                                                                                                                            
+      
                                                                                                                            
+        
                                                                                                                            
+                      Generates color-coded HTML 4.01 from C# source code.
+        
                                                                                                                            
+      
                                                                                                                            
+    
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+    
                                                                                                                            
+      Constructors
+    
                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                            
+            Constructor
+          
+            Description
+            
+          
                                                                                                                            
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
+                    
+                      CSharpFormat()
+                    
+                  
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  Full Usage: 
+                  CSharpFormat()
+                  
                                                                                                                            
+                  
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+                                                                                                                                      		
+            
                                                                                                                            
+              
                                                                                                                            
+                
                                                                                                                            
+                  
+                
                                                                                                                            
+              
                                                                                                                            
+              
                                                                                                                            
+                
                                                                                                                            
+                  
+                
                                                                                                                            
+                
                                                                                                                            
+                  
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+          
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+    
                                                                                                                            
+      Instance members
+    
                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                            
+            Instance member
+          
+            Description
+            
+          
                                                                                                                            
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                            
+                  
                                                                                                                            
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                            
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+                                                                                                                                      		
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                                  The list of C# keywords.
+                    
                                                                                                                            
+                  
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                  
                                                                                                                            
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+          
                                                                                                                            
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
+                    
+                      this.Operators
+                    
+                  
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  Full Usage: 
+                  this.Operators
+                  
                                                                                                                            
+                  
                                                                                                                            
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                            
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+                                                                                                                                      		
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                                  TBD
+                    
                                                                                                                            
+                  
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                  
                                                                                                                            
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+          
                                                                                                                            
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                            
+                  
                                                                                                                            
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                            
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+                                                                                                                                      		
+            
                                                                                                                            
+              
+                
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                                  The list of C# preprocessors.
+                    
                                                                                                                            
+                  
                                                                                                                            
+                  
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                    
                                                                                                                            
+                      
+                    
                                                                                                                            
+                  
                                                                                                                            
+                
                                                                                                                            
+                                                                                                                                          
+              
                                                                                                                            
+                
                                                                                                                            
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                            
+                
                                                                                                                            
+              
                                                                                                                            
+            
                                                                                                                            
+          
                                                                                                                            
+  
                                                                                                                            
+  
                                                                                                                            
+
                                                                                                                            
+        
+    
                                                                                                                            
+
                                                                                                                            
+
+
+    
+    
                                                                                                                            
+        
                                                                                                                              
+        
                                                                                                                              Type something to start searching.
                                                                                                                              
+    
                                                                                                                              
+                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-fsharpformat.html b/reference/fsharp-formatting-csharpformat-fsharpformat.html
new file mode 100644
index 000000000..85c9c20ab
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-fsharpformat.html
@@ -0,0 +1,735 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharpFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                              
+    
                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                              
+    
                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                              
+
                                                                                                                              
+
+
                                                                                                                              
+    
                                                                                                                              
+        
                                                                                                                              
+  
                                                                                                                              
+    FSharpFormat Type
+  
                                                                                                                              
+  
                                                                                                                              
+    
                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                              
+    
                                                                                                                              
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                              
+    
                                                                                                                              
+      Base Type: 
+      CLikeFormat
+    
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+    
                                                                                                                              
+      
                                                                                                                              
+        
                                                                                                                              
+                      Generates color-coded HTML 4.01 from F# source code.
+        
                                                                                                                              
+      
                                                                                                                              
+    
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+    
                                                                                                                              
+      Constructors
+    
                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                              
+            Constructor
+          
+            Description
+            
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      FSharpFormat()
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  FSharpFormat()
+                  
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                
                                                                                                                              
+              
                                                                                                                              
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                
                                                                                                                              
+                
                                                                                                                              
+                  
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+    
                                                                                                                              
+      Instance members
+    
                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                              
+            Instance member
+          
+            Description
+            
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                              
+                  
                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                                  Regular expression string to match single line and multi-line 
+            comments (// and (* *)).
+                    
                                                                                                                              
+                  
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                              
+                  
                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                                  The list of F# keywords.
+                    
                                                                                                                              
+                  
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      this.Operators
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  this.Operators
+                  
                                                                                                                              
+                  
                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                                  TBD
+                    
                                                                                                                              
+                  
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                              
+                  
                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                                  TBD
+                    
                                                                                                                              
+                  
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                              
+                  
                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+                                                                                                                                        		
+            
                                                                                                                              
+              
+                
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                              
+                  
                                                                                                                              
+                  
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                    
                                                                                                                              
+                      
+                    
                                                                                                                              
+                  
                                                                                                                              
+                
                                                                                                                              
+                                                                                                                                            
+              
                                                                                                                              
+                
                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                              
+                
                                                                                                                              
+              
                                                                                                                              
+            
                                                                                                                              
+          
                                                                                                                              
+  
                                                                                                                              
+  
                                                                                                                              
+
                                                                                                                              
+        
+    
                                                                                                                              
+
                                                                                                                              
+
+
+    
+    
                                                                                                                              
+        
                                                                                                                                
+        
                                                                                                                                Type something to start searching.
                                                                                                                                
+    
                                                                                                                                
+                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-haskellformat.html b/reference/fsharp-formatting-csharpformat-haskellformat.html
new file mode 100644
index 000000000..d9fcd8861
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-haskellformat.html
@@ -0,0 +1,673 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    HaskellFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                
+    
                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                
+    
                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                
+
                                                                                                                                
+
+
                                                                                                                                
+    
                                                                                                                                
+        
                                                                                                                                
+  
                                                                                                                                
+    HaskellFormat Type
+  
                                                                                                                                
+  
                                                                                                                                
+    
                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                
+    
                                                                                                                                
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                
+    
                                                                                                                                
+      Base Type: 
+      CodeFormat
+    
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+    
                                                                                                                                
+      
                                                                                                                                
+        
                                                                                                                                
+                      Generates color-coded HTML 4.01 from MSH (code name Monad) source code.
+        
                                                                                                                                
+      
                                                                                                                                
+    
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+    
                                                                                                                                
+      Constructors
+    
                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
+                    
+                      HaskellFormat()
+                    
+                  
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  Full Usage: 
+                  HaskellFormat()
+                  
                                                                                                                                
+                  
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+                                                                                                                                          		
+            
                                                                                                                                
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                
                                                                                                                                
+              
                                                                                                                                
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                
                                                                                                                                
+                
                                                                                                                                
+                  
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+          
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+    
                                                                                                                                
+      Instance members
+    
                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                                
+                  
                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+                                                                                                                                          		
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                                  Regular expression string to match single line comments (#).
+                    
                                                                                                                                
+                  
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                  
                                                                                                                                
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+          
                                                                                                                                
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                
+                  
                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+                                                                                                                                          		
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                                  The list of MSH keywords.
+                    
                                                                                                                                
+                  
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                  
                                                                                                                                
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+          
                                                                                                                                
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                
+                  
                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+                                                                                                                                          		
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                                  Use preprocessors property to hilight operators.
+                    
                                                                                                                                
+                  
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                  
                                                                                                                                
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+          
                                                                                                                                
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                                
+                  
                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+                                                                                                                                          		
+            
                                                                                                                                
+              
+                
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                                
+                  
                                                                                                                                
+                  
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                    
                                                                                                                                
+                      
+                    
                                                                                                                                
+                  
                                                                                                                                
+                
                                                                                                                                
+                                                                                                                                              
+              
                                                                                                                                
+                
                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                
+                
                                                                                                                                
+              
                                                                                                                                
+            
                                                                                                                                
+          
                                                                                                                                
+  
                                                                                                                                
+  
                                                                                                                                
+
                                                                                                                                
+        
+    
                                                                                                                                
+
                                                                                                                                
+
+
+    
+    
                                                                                                                                
+        
                                                                                                                                  
+        
                                                                                                                                  Type something to start searching.
                                                                                                                                  
+    
                                                                                                                                  
+                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-htmlformat.html b/reference/fsharp-formatting-csharpformat-htmlformat.html
new file mode 100644
index 000000000..5f272d079
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-htmlformat.html
@@ -0,0 +1,414 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    HtmlFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                  
+    
                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                  
+    
                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                  
+
                                                                                                                                  
+
+
                                                                                                                                  
+    
                                                                                                                                  
+        
                                                                                                                                  
+  
                                                                                                                                  
+    HtmlFormat Type
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                  
+    
                                                                                                                                  
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                  
+    
                                                                                                                                  
+      Base Type: 
+      SourceFormat
+    
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      
                                                                                                                                  
+        
                                                                                                                                  
+          
+            Generates color-coded HTML 4.01 from HTML/XML/ASPX source code.
+            
+        
                                                                                                                                  
+      
                                                                                                                                  
+    
                                                                                                                                  
+    
                                                                                                                                  
+      
                                                                                                                                  
+            This implementation assumes that code inside 
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-javascriptformat.html b/reference/fsharp-formatting-csharpformat-javascriptformat.html
new file mode 100644
index 000000000..ba04de4d7
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-javascriptformat.html
@@ -0,0 +1,612 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    JavaScriptFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                  
+    
                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                  
+    
                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                  
+
                                                                                                                                  
+
+
                                                                                                                                  
+    
                                                                                                                                  
+        
                                                                                                                                  
+  
                                                                                                                                  
+    JavaScriptFormat Type
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                  
+    
                                                                                                                                  
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                  
+    
                                                                                                                                  
+      Base Type: 
+      CLikeFormat
+    
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      
                                                                                                                                  
+        
                                                                                                                                  
+                      Generates color-coded HTML 4.01 from JavaSctript source code.
+        
                                                                                                                                  
+      
                                                                                                                                  
+    
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      Constructors
+    
                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                  
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                  
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
+                    
+                      JavaScriptFormat()
+                    
+                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  Full Usage: 
+                  JavaScriptFormat()
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+                                                                                                                                            		
+            
                                                                                                                                  
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+          
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+    
                                                                                                                                  
+      Instance members
+    
                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                  
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                  
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+                                                                                                                                            		
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                                  The list of JavaScript keywords.
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+          
                                                                                                                                  
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
+                    
+                      this.Operators
+                    
+                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  Full Usage: 
+                  this.Operators
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+                                                                                                                                            		
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                                  TBD
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+          
                                                                                                                                  
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+                                                                                                                                            		
+            
                                                                                                                                  
+              
+                
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                                  Use the pre-processor color to mark directives that start with @.
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                  
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                    
                                                                                                                                  
+                      
+                    
                                                                                                                                  
+                  
                                                                                                                                  
+                
                                                                                                                                  
+                                                                                                                                                
+              
                                                                                                                                  
+                
                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                  
+                
                                                                                                                                  
+              
                                                                                                                                  
+            
                                                                                                                                  
+          
                                                                                                                                  
+  
                                                                                                                                  
+  
                                                                                                                                  
+
                                                                                                                                  
+        
+    
                                                                                                                                  
+
                                                                                                                                  
+
+
+    
+    
                                                                                                                                  
+        
                                                                                                                                    
+        
                                                                                                                                    Type something to start searching.
                                                                                                                                    
+    
                                                                                                                                    
+                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-mshformat.html b/reference/fsharp-formatting-csharpformat-mshformat.html
new file mode 100644
index 000000000..506dd47bc
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-mshformat.html
@@ -0,0 +1,673 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MshFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                    
+    
                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                    
+    
                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                    
+
                                                                                                                                    
+
+
                                                                                                                                    
+    
                                                                                                                                    
+        
                                                                                                                                    
+  
                                                                                                                                    
+    MshFormat Type
+  
                                                                                                                                    
+  
                                                                                                                                    
+    
                                                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                    
+    
                                                                                                                                    
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                    
+    
                                                                                                                                    
+      Base Type: 
+      CodeFormat
+    
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+    
                                                                                                                                    
+      
                                                                                                                                    
+        
                                                                                                                                    
+                      Generates color-coded HTML 4.01 from MSH (code name Monad) source code.
+        
                                                                                                                                    
+      
                                                                                                                                    
+    
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+    
                                                                                                                                    
+      Constructors
+    
                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                    
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                    
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
+                    
+                      MshFormat()
+                    
+                  
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  Full Usage: 
+                  MshFormat()
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+                                                                                                                                              		
+            
                                                                                                                                    
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                
                                                                                                                                    
+              
                                                                                                                                    
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+          
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+    
                                                                                                                                    
+      Instance members
+    
                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                    
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                    
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                    
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+                                                                                                                                              		
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                                  Regular expression string to match single line comments (#).
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+          
                                                                                                                                    
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                    
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+                                                                                                                                              		
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                                  The list of MSH keywords.
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+          
                                                                                                                                    
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                    
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+                                                                                                                                              		
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                                  Use preprocessors property to hilight operators.
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+          
                                                                                                                                    
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                    
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+                                                                                                                                              		
+            
                                                                                                                                    
+              
+                
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                  
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                    
                                                                                                                                    
+                      
+                    
                                                                                                                                    
+                  
                                                                                                                                    
+                
                                                                                                                                    
+                                                                                                                                                  
+              
                                                                                                                                    
+                
                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                    
+                
                                                                                                                                    
+              
                                                                                                                                    
+            
                                                                                                                                    
+          
                                                                                                                                    
+  
                                                                                                                                    
+  
                                                                                                                                    
+
                                                                                                                                    
+        
+    
                                                                                                                                    
+
                                                                                                                                    
+
+
+    
+    
                                                                                                                                    
+        
                                                                                                                                      
+        
                                                                                                                                      Type something to start searching.
                                                                                                                                      
+    
                                                                                                                                      
+                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-paketformat.html b/reference/fsharp-formatting-csharpformat-paketformat.html
new file mode 100644
index 000000000..476d84ef6
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-paketformat.html
@@ -0,0 +1,675 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    PaketFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                      
+    
                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                      
+    
                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                      
+
                                                                                                                                      
+
+
                                                                                                                                      
+    
                                                                                                                                      
+        
                                                                                                                                      
+  
                                                                                                                                      
+    PaketFormat Type
+  
                                                                                                                                      
+  
                                                                                                                                      
+    
                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                      
+    
                                                                                                                                      
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                      
+    
                                                                                                                                      
+      Base Type: 
+      FSharpFormat
+    
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+    
                                                                                                                                      
+      
                                                                                                                                      
+        
                                                                                                                                      
+                      Generates color-coded Paket source code.
+        
                                                                                                                                      
+      
                                                                                                                                      
+    
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+    
                                                                                                                                      
+      Constructors
+    
                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                      
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                      
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
+                    
+                      PaketFormat()
+                    
+                  
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  Full Usage: 
+                  PaketFormat()
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+                                                                                                                                                		
+            
                                                                                                                                      
+              
                                                                                                                                      
+                
                                                                                                                                      
+                              TBD
+                
                                                                                                                                      
+              
                                                                                                                                      
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+          
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+    
                                                                                                                                      
+      Instance members
+    
                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                      
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                      
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+                                                                                                                                                		
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                                   Regular expression string to match single line and multi-line 
+             comments (// and (* *)). Single line comments should have to have 
+             a space after them to avoid color as comments URLs and paths. For example
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+          
                                                                                                                                      
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+                                                                                                                                                		
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                                  Paket Keywords
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+          
                                                                                                                                      
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
+                    
+                      this.NumberRegEx
+                    
+                  
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  Full Usage: 
+                  this.NumberRegEx
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+                                                                                                                                                		
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                                  Matches version numbers
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+          
                                                                                                                                      
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
+                    
+                      this.Operators
+                    
+                  
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  Full Usage: 
+                  this.Operators
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+                                                                                                                                                		
+            
                                                                                                                                      
+              
+                
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                                  Paket operators
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                  
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                    
                                                                                                                                      
+                      
+                    
                                                                                                                                      
+                  
                                                                                                                                      
+                
                                                                                                                                      
+                                                                                                                                                    
+              
                                                                                                                                      
+                
                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                      
+                
                                                                                                                                      
+              
                                                                                                                                      
+            
                                                                                                                                      
+          
                                                                                                                                      
+  
                                                                                                                                      
+  
                                                                                                                                      
+
                                                                                                                                      
+        
+    
                                                                                                                                      
+
                                                                                                                                      
+
+
+    
+    
                                                                                                                                      
+        
                                                                                                                                        
+        
                                                                                                                                        Type something to start searching.
                                                                                                                                        
+    
                                                                                                                                        
+                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-phpformat.html b/reference/fsharp-formatting-csharpformat-phpformat.html
new file mode 100644
index 000000000..322c71d28
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-phpformat.html
@@ -0,0 +1,612 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    PhpFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                        
+    
                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                        
+    
                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                        
+
                                                                                                                                        
+
+
                                                                                                                                        
+    
                                                                                                                                        
+        
                                                                                                                                        
+  
                                                                                                                                        
+    PhpFormat Type
+  
                                                                                                                                        
+  
                                                                                                                                        
+    
                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                        
+    
                                                                                                                                        
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                        
+    
                                                                                                                                        
+      Base Type: 
+      CLikeFormat
+    
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+    
                                                                                                                                        
+      
                                                                                                                                        
+        
                                                                                                                                        
+                      Generates color-coded HTML 4.01 from PHP source code.
+        
                                                                                                                                        
+      
                                                                                                                                        
+    
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+    
                                                                                                                                        
+      Constructors
+    
                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                        
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                        
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
+                    
+                      PhpFormat()
+                    
+                  
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  Full Usage: 
+                  PhpFormat()
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+                                                                                                                                                  		
+            
                                                                                                                                        
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                
                                                                                                                                        
+              
                                                                                                                                        
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+          
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+    
                                                                                                                                        
+      Instance members
+    
                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                        
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                        
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+                                                                                                                                                  		
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                                  The list of PHP keywords.
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+          
                                                                                                                                        
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+                                                                                                                                                  		
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                                  The list of PHP preprocessors.
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+          
                                                                                                                                        
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+                                                                                                                                                  		
+            
                                                                                                                                        
+              
+                
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                  
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                    
                                                                                                                                        
+                      
+                    
                                                                                                                                        
+                  
                                                                                                                                        
+                
                                                                                                                                        
+                                                                                                                                                      
+              
                                                                                                                                        
+                
                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                        
+                
                                                                                                                                        
+              
                                                                                                                                        
+            
                                                                                                                                        
+          
                                                                                                                                        
+  
                                                                                                                                        
+  
                                                                                                                                        
+
                                                                                                                                        
+        
+    
                                                                                                                                        
+
                                                                                                                                        
+
+
+    
+    
                                                                                                                                        
+        
                                                                                                                                          
+        
                                                                                                                                          Type something to start searching.
                                                                                                                                          
+    
                                                                                                                                          
+                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-sourceformat.html b/reference/fsharp-formatting-csharpformat-sourceformat.html
new file mode 100644
index 000000000..bf5e1453e
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-sourceformat.html
@@ -0,0 +1,1154 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    SourceFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                          
+    
                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                          
+    
                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                          
+
                                                                                                                                          
+
+
                                                                                                                                          
+    
                                                                                                                                          
+        
                                                                                                                                          
+  
                                                                                                                                          
+    SourceFormat Type
+  
                                                                                                                                          
+  
                                                                                                                                          
+    
                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                          
+    
                                                                                                                                          
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                          
+    
                                                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+    
                                                                                                                                          
+      
                                                                                                                                          
+        
                                                                                                                                          
+          
+            Provides a base implementation for all code formatters.
+            
+        
                                                                                                                                          
+      
                                                                                                                                          
+    
                                                                                                                                          
+    
                                                                                                                                          
+      
                                                                                                                                          
+            To display the formatted code on your web site, the web page must 
+            refer to a stylesheet that defines the formatting for the different 
+            CSS classes generated by CSharpFormat:
+            .csharpcode, pre, .rem, .kwrd, .str, .op, .preproc, .alt, .lnum.
+            
                                                                                                                                          
+            Note that if you have multi-line comments in your source code
+            (like /* ... */), the "line numbers" or "alternate line background" 
+            options will generate code that is not strictly HTML 4.01 compliant. 
+            The code will still look good with IE5+ or Mozilla 0.8+. 
+            
                                                                                                                                          
+    
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+    
                                                                                                                                          
+      Constructors
+    
                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                          
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      SourceFormat()
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  SourceFormat()
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+    
                                                                                                                                          
+      Instance members
+    
                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                          
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.Alternate
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.Alternate
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+            Enables or disables alternating line background.
+            
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.CodeRegex
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.CodeRegex
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                              The regular expression used to capture language tokens.
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.EmbedStyleSheet
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.EmbedStyleSheet
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+            Enables or disables the embedded CSS style sheet.
+            
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.FormatCode
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.FormatCode
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  Parameters: 
+                  
                                                                                                                                            
+                    
+                      
+                        source
+                      
+                      :
+                      Stream
+                       - 
+                      Source code stream.
+                    
+                    
                                                                                                                                            
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  A string containing the HTML formatted code.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+            Transforms a source code stream to HTML 4.01.
+            
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    source
+                  
+                  :
+                  Stream
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    Source code stream.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    A string containing the HTML formatted code.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.FormatCode
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.FormatCode
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  Parameters: 
+                  
                                                                                                                                            
+                    
+                      
+                        source
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                            
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  A string containing the HTML formatted code.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+            Transforms a source code string to HTML 4.01.
+            
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    source
+                  
+                  :
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    A string containing the HTML formatted code.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.FormatSubCode
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.FormatSubCode
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  Parameters: 
+                  
                                                                                                                                            
+                    
+                      
+                        source
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                            
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                                  Allows formatting a part of the code in a different language,
+            for example a JavaScript block inside an HTML file.
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    source
+                  
+                  :
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.LineNumbers
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.LineNumbers
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+            Enables or disables line numbers in output.
+            
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      this.TabSpaces
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  this.TabSpaces
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+            Gets or sets the tabs width.
+            
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+  
                                                                                                                                          
+  
                                                                                                                                          
+    
                                                                                                                                          
+      Static members
+    
                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                          
+            Static member
+          
+            Description
+            
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      SourceFormat.EscapeHtml(str, tabSpaces)
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  SourceFormat.EscapeHtml(str, tabSpaces)
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  Parameters: 
+                  
                                                                                                                                            
+                    
+                      
+                        str
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                            
+                    
+                      
+                        tabSpaces
+                      
+                      :
+                      int
+                    
+                    
                                                                                                                                            
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                                  TBD
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    str
+                  
+                  :
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    tabSpaces
+                  
+                  :
+                  int
+                
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      SourceFormat.GetCssStream()
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  SourceFormat.GetCssStream()
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    Stream
+                  
+                  A text Stream of the CSS definitions.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+            Gets the CSS stylesheet as a stream.
+            
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  Stream
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    A text Stream of the CSS definitions.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
+                    
+                      SourceFormat.GetCssString()
+                    
+                  
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  Full Usage: 
+                  SourceFormat.GetCssString()
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                  
+                    Returns: 
+                    string
+                  
+                  A string containing the CSS definitions.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+                                                                                                                                                    		
+            
                                                                                                                                          
+              
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+            Gets the CSS stylesheet as a string.
+            
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                  
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                    
                                                                                                                                          
+                      
+                    
                                                                                                                                          
+                  
                                                                                                                                          
+                
                                                                                                                                          
+                                                                                                                                                        
+              
                                                                                                                                          
+                
                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                          
+                
                                                                                                                                          
+                  
                                                                                                                                          
+                    A string containing the CSS definitions.
+                  
                                                                                                                                          
+                
                                                                                                                                          
+              
                                                                                                                                          
+            
                                                                                                                                          
+          
                                                                                                                                          
+  
                                                                                                                                          
+
                                                                                                                                          
+        
+    
                                                                                                                                          
+
                                                                                                                                          
+
+
+    
+    
                                                                                                                                          
+        
                                                                                                                                            
+        
                                                                                                                                            Type something to start searching.
                                                                                                                                            
+    
                                                                                                                                            
+                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html b/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html
new file mode 100644
index 000000000..ac419f45e
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-syntaxhighlighter.html
@@ -0,0 +1,605 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    SyntaxHighlighter (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                            
+    
                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                            
+    
                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                            
+
                                                                                                                                            
+
+
                                                                                                                                            
+    
                                                                                                                                            
+        
                                                                                                                                            
+  
                                                                                                                                            
+    SyntaxHighlighter Type
+  
                                                                                                                                            
+  
                                                                                                                                            
+    
                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                            
+    
                                                                                                                                            
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                            
+    
                                                                                                                                            
+      Base Type: 
+      obj
+    
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+    
                                                                                                                                            
+      
                                                                                                                                            
+        
                                                                                                                                            
+                      Summary description for SyntaxHighlighter
+        
                                                                                                                                            
+      
                                                                                                                                            
+    
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+    
                                                                                                                                            
+      Constructors
+    
                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                            
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                            
+            
                                                                                                                                            
+              
+                
                                                                                                                                            
+                  
+                    
+                      SyntaxHighlighter()
+                    
+                  
+                
                                                                                                                                            
+                                                                                                                                                          
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  Full Usage: 
+                  SyntaxHighlighter()
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+                                                                                                                                                      		
+            
                                                                                                                                            
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                
                                                                                                                                            
+              
                                                                                                                                            
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+          
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+  
                                                                                                                                            
+    
                                                                                                                                            
+      Static members
+    
                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                            
+            Static member
+          
+            Description
+            
+          
                                                                                                                                            
+            
                                                                                                                                            
+              
+                
                                                                                                                                            
+                  
+                    
+                      SyntaxHighlighter.FormatCode(lang, code)
+                    
+                  
+                
                                                                                                                                            
+                                                                                                                                                          
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  Full Usage: 
+                  SyntaxHighlighter.FormatCode(lang, code)
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                              
+                    
+                      
+                        lang
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                              
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                              
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                  
+                    Returns: 
+                    bool * string
+                  
+                  
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+                                                                                                                                                      		
+            
                                                                                                                                            
+              
+                
                                                                                                                                            
+                  
                                                                                                                                            
+                    
                                                                                                                                            
+                                  TBD
+                    
                                                                                                                                            
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                    
                                                                                                                                            
+                      
+                    
                                                                                                                                            
+                    
                                                                                                                                            
+                      
+                    
                                                                                                                                            
+                  
                                                                                                                                            
+                
                                                                                                                                            
+                                                                                                                                                          
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                    lang
+                  
+                  :
+                  string
+                
                                                                                                                                            
+                
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  bool * string
+                
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+          
                                                                                                                                            
+            
                                                                                                                                            
+              
+                
                                                                                                                                            
+                  
+                    
+                      SyntaxHighlighter.FormatHtml(input)
+                    
+                  
+                
                                                                                                                                            
+                                                                                                                                                          
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  Full Usage: 
+                  SyntaxHighlighter.FormatHtml(input)
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                              
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                              
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+                                                                                                                                                      		
+            
                                                                                                                                            
+              
+                
                                                                                                                                            
+                  
                                                                                                                                            
+                    
                                                                                                                                            
+                                  TBD
+                    
                                                                                                                                            
+                  
                                                                                                                                            
+                  
                                                                                                                                            
+                    
                                                                                                                                            
+                      
+                    
                                                                                                                                            
+                    
                                                                                                                                            
+                      
+                    
                                                                                                                                            
+                  
                                                                                                                                            
+                
                                                                                                                                            
+                                                                                                                                                          
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+              
                                                                                                                                            
+                
                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                            
+                
                                                                                                                                            
+              
                                                                                                                                            
+            
                                                                                                                                            
+          
                                                                                                                                            
+  
                                                                                                                                            
+
                                                                                                                                            
+        
+    
                                                                                                                                            
+
                                                                                                                                            
+
+
+    
+    
                                                                                                                                            
+        
                                                                                                                                              
+        
                                                                                                                                              Type something to start searching.
                                                                                                                                              
+    
                                                                                                                                              
+                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-tsqlformat.html b/reference/fsharp-formatting-csharpformat-tsqlformat.html
new file mode 100644
index 000000000..0e4a3c354
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-tsqlformat.html
@@ -0,0 +1,737 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TsqlFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                              
+    
                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                              
+    
                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                              
+
                                                                                                                                              
+
+
                                                                                                                                              
+    
                                                                                                                                              
+        
                                                                                                                                              
+  
                                                                                                                                              
+    TsqlFormat Type
+  
                                                                                                                                              
+  
                                                                                                                                              
+    
                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                              
+    
                                                                                                                                              
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                              
+    
                                                                                                                                              
+      Base Type: 
+      CodeFormat
+    
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+    
                                                                                                                                              
+      
                                                                                                                                              
+        
                                                                                                                                              
+                      Generates color-coded T-SQL source code.
+        
                                                                                                                                              
+      
                                                                                                                                              
+    
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+    
                                                                                                                                              
+      Constructors
+    
                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                              
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      TsqlFormat()
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  TsqlFormat()
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                
                                                                                                                                              
+              
                                                                                                                                              
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+    
                                                                                                                                              
+      Instance members
+    
                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                              
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      this.CaseSensitive
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  this.CaseSensitive
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+            Returns false, since T-SQL is not case sensitive.
+            
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                                  Regular expression string to match single line 
+            comments (--).
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                                  The list of T-SQL keywords.
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                                  Use the pre-processor color to mark keywords that start with @@.
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                              
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+                                                                                                                                                        		
+            
                                                                                                                                              
+              
+                
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                                  Regular expression string to match string literals. 
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                  
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                    
                                                                                                                                              
+                      
+                    
                                                                                                                                              
+                  
                                                                                                                                              
+                
                                                                                                                                              
+                                                                                                                                                            
+              
                                                                                                                                              
+                
                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                              
+                
                                                                                                                                              
+              
                                                                                                                                              
+            
                                                                                                                                              
+          
                                                                                                                                              
+  
                                                                                                                                              
+  
                                                                                                                                              
+
                                                                                                                                              
+        
+    
                                                                                                                                              
+
                                                                                                                                              
+
+
+    
+    
                                                                                                                                              
+        
                                                                                                                                                
+        
                                                                                                                                                Type something to start searching.
                                                                                                                                                
+    
                                                                                                                                                
+                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-typescriptformat.html b/reference/fsharp-formatting-csharpformat-typescriptformat.html
new file mode 100644
index 000000000..41aa300ff
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-typescriptformat.html
@@ -0,0 +1,490 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    TypeScriptFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                
+    
                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                
+    
                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                
+
                                                                                                                                                
+
+
                                                                                                                                                
+    
                                                                                                                                                
+        
                                                                                                                                                
+  
                                                                                                                                                
+    TypeScriptFormat Type
+  
                                                                                                                                                
+  
                                                                                                                                                
+    
                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                                
+    
                                                                                                                                                
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                                
+    
                                                                                                                                                
+      Base Type: 
+      JavaScriptFormat
+    
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+    
                                                                                                                                                
+      
                                                                                                                                                
+        
                                                                                                                                                
+                      Generates color-coded HTML 4.01 from TypeScript source code.
+        
                                                                                                                                                
+      
                                                                                                                                                
+    
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+    
                                                                                                                                                
+      Constructors
+    
                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                
+            
                                                                                                                                                
+              
+                
                                                                                                                                                
+                  
+                    
+                      TypeScriptFormat()
+                    
+                  
+                
                                                                                                                                                
+                                                                                                                                                              
+              
                                                                                                                                                
+                
                                                                                                                                                
+                  Full Usage: 
+                  TypeScriptFormat()
+                  
                                                                                                                                                
+                  
                                                                                                                                                
+                
                                                                                                                                                
+              
                                                                                                                                                
+            
                                                                                                                                                
+                                                                                                                                                          		
+            
                                                                                                                                                
+              
                                                                                                                                                
+                
                                                                                                                                                
+                  
+                
                                                                                                                                                
+              
                                                                                                                                                
+              
                                                                                                                                                
+                
                                                                                                                                                
+                  
+                
                                                                                                                                                
+                
                                                                                                                                                
+                  
+                
                                                                                                                                                
+              
                                                                                                                                                
+            
                                                                                                                                                
+          
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+    
                                                                                                                                                
+      Instance members
+    
                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                
+            
                                                                                                                                                
+              
+                
                                                                                                                                                
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                                
+                                                                                                                                                              
+              
                                                                                                                                                
+                
                                                                                                                                                
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                                
+                  
                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                
+                
                                                                                                                                                
+              
                                                                                                                                                
+            
                                                                                                                                                
+                                                                                                                                                          		
+            
                                                                                                                                                
+              
+                
                                                                                                                                                
+                  
                                                                                                                                                
+                    
                                                                                                                                                
+                                  The list of TypeScript keywords extends the ones from JavaScript.
+                    
                                                                                                                                                
+                  
                                                                                                                                                
+                  
                                                                                                                                                
+                    
                                                                                                                                                
+                      
+                    
                                                                                                                                                
+                    
                                                                                                                                                
+                      
+                    
                                                                                                                                                
+                  
                                                                                                                                                
+                
                                                                                                                                                
+                                                                                                                                                              
+              
                                                                                                                                                
+                
                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                
+                
                                                                                                                                                
+              
                                                                                                                                                
+            
                                                                                                                                                
+          
                                                                                                                                                
+  
                                                                                                                                                
+  
                                                                                                                                                
+
                                                                                                                                                
+        
+    
                                                                                                                                                
+
                                                                                                                                                
+
+
+    
+    
                                                                                                                                                
+        
                                                                                                                                                  
+        
                                                                                                                                                  Type something to start searching.
                                                                                                                                                  
+    
                                                                                                                                                  
+                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat-visualbasicformat.html b/reference/fsharp-formatting-csharpformat-visualbasicformat.html
new file mode 100644
index 000000000..15847ab47
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat-visualbasicformat.html
@@ -0,0 +1,736 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    VisualBasicFormat (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                  
+    
                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                  
+    
                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                  
+
                                                                                                                                                  
+
+
                                                                                                                                                  
+    
                                                                                                                                                  
+        
                                                                                                                                                  
+  
                                                                                                                                                  
+    VisualBasicFormat Type
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+    
                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.CSharpFormat
+      
+    
                                                                                                                                                  
+    
                                                                                                                                                  
+      Assembly: FSharp.Formatting.CSharpFormat.dll
+    
                                                                                                                                                  
+    
                                                                                                                                                  
+      Base Type: 
+      CodeFormat
+    
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+    
                                                                                                                                                  
+      
                                                                                                                                                  
+        
                                                                                                                                                  
+                      Generates color-coded HTML 4.01 from Visual Basic source code.
+        
                                                                                                                                                  
+      
                                                                                                                                                  
+    
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+    
                                                                                                                                                  
+      Constructors
+    
                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                  
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      VisualBasicFormat()
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  VisualBasicFormat()
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+    
                                                                                                                                                  
+      Instance members
+    
                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                  
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      this.CaseSensitive
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  this.CaseSensitive
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+            Determines if the language is case sensitive.
+            
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      this.CommentRegEx
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  this.CommentRegEx
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                                  Regular expression string to match comments (' and REM). 
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      this.Keywords
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  this.Keywords
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                                  The list of VB keywords.
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      this.Preprocessors
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  this.Preprocessors
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                                  The list of VB preprocessors.
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
+                    
+                      this.StringRegEx
+                    
+                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  Full Usage: 
+                  this.StringRegEx
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+                                                                                                                                                            		
+            
                                                                                                                                                  
+              
+                
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                                  Regular expression string to match string and character literals. 
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                  
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                    
                                                                                                                                                  
+                      
+                    
                                                                                                                                                  
+                  
                                                                                                                                                  
+                
                                                                                                                                                  
+                                                                                                                                                                
+              
                                                                                                                                                  
+                
                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                  
+                
                                                                                                                                                  
+              
                                                                                                                                                  
+            
                                                                                                                                                  
+          
                                                                                                                                                  
+  
                                                                                                                                                  
+  
                                                                                                                                                  
+
                                                                                                                                                  
+        
+    
                                                                                                                                                  
+
                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                  
+        
                                                                                                                                                    
+        
                                                                                                                                                    Type something to start searching.
                                                                                                                                                    
+    
                                                                                                                                                    
+                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-csharpformat.html b/reference/fsharp-formatting-csharpformat.html
new file mode 100644
index 000000000..647df07cd
--- /dev/null
+++ b/reference/fsharp-formatting-csharpformat.html
@@ -0,0 +1,839 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.CSharpFormat | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                    
+    
                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                    
+    
                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                    
+
                                                                                                                                                    
+
+
                                                                                                                                                    
+    
                                                                                                                                                    
+        
                                                                                                                                                    
+  
                                                                                                                                                    
+    FSharp.Formatting.CSharpFormat Namespace
+  
                                                                                                                                                    
+  
                                                                                                                                                    
+    
                                                                                                                                                    
+      Functionality for formatting code in various languages
+    
                                                                                                                                                    
+  
                                                                                                                                                    
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                    
+          Type
+        
+          Description
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                CLikeFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+             Provides a base class for formatting languages similar to C.
+             
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                CodeFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Provides a base class for formatting most programming languages.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                CPlusPlusFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from C++ source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                CSharpFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from C# source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                FSharpFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from F# source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                HaskellFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from MSH (code name Monad) source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                HtmlFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+            Generates color-coded HTML 4.01 from HTML/XML/ASPX source code.
+            
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                JavaScriptFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from JavaSctript source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                MshFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from MSH (code name Monad) source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                PaketFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded Paket source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                PhpFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from PHP source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                SourceFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+            Provides a base implementation for all code formatters.
+            
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                SyntaxHighlighter
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Summary description for SyntaxHighlighter
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                TsqlFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded T-SQL source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                TypeScriptFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from TypeScript source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+          
                                                                                                                                                    
+            
+              
+                VisualBasicFormat
+              
+            
+          
                                                                                                                                                    
+                                                                                                                                                            		
+          
                                                                                                                                                    
+            
                                                                                                                                                    
+              
                                                                                                                                                    
+                            Generates color-coded HTML 4.01 from Visual Basic source code.
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+            
                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+              
                                                                                                                                                    
+                
+              
                                                                                                                                                    
+            
                                                                                                                                                    
+          
                                                                                                                                                    
+        
                                                                                                                                                    
+
                                                                                                                                                    
+        
+    
                                                                                                                                                    
+
                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                    
+        
                                                                                                                                                      
+        
                                                                                                                                                      Type something to start searching.
                                                                                                                                                      
+    
                                                                                                                                                      
+                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html b/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html
new file mode 100644
index 000000000..a7fc887b0
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-fsiembedkind.html
@@ -0,0 +1,609 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FsiEmbedKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                      
+    
                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                      
+    
                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                      
+
                                                                                                                                                      
+
+
                                                                                                                                                      
+    
                                                                                                                                                      
+        
                                                                                                                                                      
+  
                                                                                                                                                      
+    FsiEmbedKind Type
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+    
                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                      
+    
                                                                                                                                                      
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                      
+    
                                                                                                                                                      
+      Base Type: 
+      ValueType
+    
                                                                                                                                                      
+    
                                                                                                                                                      
+      All Interfaces: 
+      IEquatable<FsiEmbedKind>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<FsiEmbedKind>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                      
+    
                                                                                                                                                      
+      Kind: Struct
+    
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+    
                                                                                                                                                      
+      
                                                                                                                                                      
+        
                                                                                                                                                      
+          
+   Represents a kind of thing that can be embedded
+ 
+        
                                                                                                                                                      
+      
                                                                                                                                                      
+    
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+    
                                                                                                                                                      
+      Union cases
+    
                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                      
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      ConsoleOutput
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  ConsoleOutput
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   The stdout from this part of the execution (not including FSI output)
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      FsiMergedOutput
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  FsiMergedOutput
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   The combined FSI output and console output
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      FsiOutput
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  FsiOutput
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   The FSI output
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      ItRaw
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  ItRaw
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   The 'it' value as raw text
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      ItValue
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  ItValue
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   The 'it' value
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+            
                                                                                                                                                      
+              
+                
                                                                                                                                                      
+                  
+                    
+                      Value
+                    
+                  
+                
                                                                                                                                                      
+                                                                                                                                                                    
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                  Full Usage: 
+                  Value
+                  
                                                                                                                                                      
+                  
                                                                                                                                                      
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+                                                                                                                                                                		
+            
                                                                                                                                                      
+              
                                                                                                                                                      
+                
                                                                                                                                                      
+                   A specific value
+                
                                                                                                                                                      
+              
                                                                                                                                                      
+              
                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                      
+            
                                                                                                                                                      
+          
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+  
                                                                                                                                                      
+
                                                                                                                                                      
+        
+    
                                                                                                                                                      
+
                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                      
+        
                                                                                                                                                        
+        
                                                                                                                                                        Type something to start searching.
                                                                                                                                                        
+    
                                                                                                                                                        
+                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html b/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html
new file mode 100644
index 000000000..b0b8a04d6
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-fsievaluationfailedinfo.html
@@ -0,0 +1,607 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FsiEvaluationFailedInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                        
+    
                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                        
+    
                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                        
+
                                                                                                                                                        
+
+
                                                                                                                                                        
+    
                                                                                                                                                        
+        
                                                                                                                                                        
+  
                                                                                                                                                        
+    FsiEvaluationFailedInfo Type
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+    
                                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                        
+    
                                                                                                                                                        
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                        
+    
                                                                                                                                                        
+      Base Type: 
+      obj
+    
                                                                                                                                                        
+    
                                                                                                                                                        
+      All Interfaces: 
+      IEquatable<FsiEvaluationFailedInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+    
                                                                                                                                                        
+      
                                                                                                                                                        
+        
                                                                                                                                                        
+           Record that is reported by the EvaluationFailed event when something
+ goes wrong during evalutaiton of an expression
+        
                                                                                                                                                        
+      
                                                                                                                                                        
+    
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+    
                                                                                                                                                        
+      Record fields
+    
                                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                        
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                        
+            
                                                                                                                                                        
+              
+                
                                                                                                                                                        
+                  
+                    
+                      AsExpression
+                    
+                  
+                
                                                                                                                                                        
+                                                                                                                                                                      
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  Full Usage: 
+                  AsExpression
+                  
                                                                                                                                                        
+                  
                                                                                                                                                        
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+                                                                                                                                                                  		
+            
                                                                                                                                                        
+              
                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                        
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  
+                    Field type: 
+                  
+                  bool
+                
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+          
                                                                                                                                                        
+            
                                                                                                                                                        
+              
+                
                                                                                                                                                        
+                  
+                    
+                      Exception
+                    
+                  
+                
                                                                                                                                                        
+                                                                                                                                                                      
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  Full Usage: 
+                  Exception
+                  
                                                                                                                                                        
+                  
                                                                                                                                                        
+                  
+                    Field type: 
+                    exn
+                  
+                  
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+                                                                                                                                                                  		
+            
                                                                                                                                                        
+              
                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                        
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  
+                    Field type: 
+                  
+                  exn
+                
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+          
                                                                                                                                                        
+            
                                                                                                                                                        
+              
+                
                                                                                                                                                        
+                  
+                    
+                      File
+                    
+                  
+                
                                                                                                                                                        
+                                                                                                                                                                      
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  Full Usage: 
+                  File
+                  
                                                                                                                                                        
+                  
                                                                                                                                                        
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+                                                                                                                                                                  		
+            
                                                                                                                                                        
+              
                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                        
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  
+                    Field type: 
+                  
+                  string option
+                
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+          
                                                                                                                                                        
+            
                                                                                                                                                        
+              
+                
                                                                                                                                                        
+                  
+                    
+                      StdErr
+                    
+                  
+                
                                                                                                                                                        
+                                                                                                                                                                      
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  Full Usage: 
+                  StdErr
+                  
                                                                                                                                                        
+                  
                                                                                                                                                        
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+                                                                                                                                                                  		
+            
                                                                                                                                                        
+              
                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                        
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+          
                                                                                                                                                        
+            
                                                                                                                                                        
+              
+                
                                                                                                                                                        
+                  
+                    
+                      Text
+                    
+                  
+                
                                                                                                                                                        
+                                                                                                                                                                      
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  Full Usage: 
+                  Text
+                  
                                                                                                                                                        
+                  
                                                                                                                                                        
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+                                                                                                                                                                  		
+            
                                                                                                                                                        
+              
                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                        
+              
                                                                                                                                                        
+                
                                                                                                                                                        
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                                                                        
+                
                                                                                                                                                        
+              
                                                                                                                                                        
+            
                                                                                                                                                        
+          
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+  
                                                                                                                                                        
+
                                                                                                                                                        
+        
+    
                                                                                                                                                        
+
                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                        
+        
                                                                                                                                                          
+        
                                                                                                                                                          Type something to start searching.
                                                                                                                                                          
+    
                                                                                                                                                          
+                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html b/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html
new file mode 100644
index 000000000..5d055f43a
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-fsievaluationresult.html
@@ -0,0 +1,609 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FsiEvaluationResult (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                          
+    
                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                          
+    
                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                          
+
                                                                                                                                                          
+
+
                                                                                                                                                          
+    
                                                                                                                                                          
+        
                                                                                                                                                          
+  
                                                                                                                                                          
+    FsiEvaluationResult Type
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+    
                                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                          
+    
                                                                                                                                                          
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                          
+    
                                                                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                                                                          
+    
                                                                                                                                                          
+      All Interfaces: 
+      IEquatable<FsiEvaluationResult>
+      , 
+      IStructuralEquatable
+      , 
+      IFsiEvaluationResult
+    
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+    
                                                                                                                                                          
+      
                                                                                                                                                          
+        
                                                                                                                                                          
+           Represents the result of evaluating an F# snippet. This contains
+ the generated console output together with a result and its static type.
+        
                                                                                                                                                          
+      
                                                                                                                                                          
+    
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+    
                                                                                                                                                          
+      Record fields
+    
                                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                          
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                          
+            
                                                                                                                                                          
+              
+                
                                                                                                                                                          
+                  
+                    
+                      FsiMergedOutput
+                    
+                  
+                
                                                                                                                                                          
+                                                                                                                                                                        
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  Full Usage: 
+                  FsiMergedOutput
+                  
                                                                                                                                                          
+                  
                                                                                                                                                          
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+                                                                                                                                                                    		
+            
                                                                                                                                                          
+              
                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                          
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string option
+                
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+          
                                                                                                                                                          
+            
                                                                                                                                                          
+              
+                
                                                                                                                                                          
+                  
+                    
+                      FsiOutput
+                    
+                  
+                
                                                                                                                                                          
+                                                                                                                                                                        
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  Full Usage: 
+                  FsiOutput
+                  
                                                                                                                                                          
+                  
                                                                                                                                                          
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+                                                                                                                                                                    		
+            
                                                                                                                                                          
+              
                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                          
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string option
+                
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+          
                                                                                                                                                          
+            
                                                                                                                                                          
+              
+                
                                                                                                                                                          
+                  
+                    
+                      ItValue
+                    
+                  
+                
                                                                                                                                                          
+                                                                                                                                                                        
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  Full Usage: 
+                  ItValue
+                  
                                                                                                                                                          
+                  
                                                                                                                                                          
+                  
+                    Field type: 
+                    (obj * Type) option
+                  
+                  
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+                                                                                                                                                                    		
+            
                                                                                                                                                          
+              
                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                          
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  (obj * Type) option
+                
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+          
                                                                                                                                                          
+            
                                                                                                                                                          
+              
+                
                                                                                                                                                          
+                  
+                    
+                      Output
+                    
+                  
+                
                                                                                                                                                          
+                                                                                                                                                                        
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  Full Usage: 
+                  Output
+                  
                                                                                                                                                          
+                  
                                                                                                                                                          
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+                                                                                                                                                                    		
+            
                                                                                                                                                          
+              
                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                          
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string option
+                
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+          
                                                                                                                                                          
+            
                                                                                                                                                          
+              
+                
                                                                                                                                                          
+                  
+                    
+                      Result
+                    
+                  
+                
                                                                                                                                                          
+                                                                                                                                                                        
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  Full Usage: 
+                  Result
+                  
                                                                                                                                                          
+                  
                                                                                                                                                          
+                  
+                    Field type: 
+                    (obj * Type) option
+                  
+                  
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+                                                                                                                                                                    		
+            
                                                                                                                                                          
+              
                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                          
+              
                                                                                                                                                          
+                
                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  (obj * Type) option
+                
                                                                                                                                                          
+                
                                                                                                                                                          
+              
                                                                                                                                                          
+            
                                                                                                                                                          
+          
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+  
                                                                                                                                                          
+
                                                                                                                                                          
+        
+    
                                                                                                                                                          
+
                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                          
+        
                                                                                                                                                            
+        
                                                                                                                                                            Type something to start searching.
                                                                                                                                                            
+    
                                                                                                                                                            
+                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-fsievaluator.html b/reference/fsharp-formatting-literate-evaluation-fsievaluator.html
new file mode 100644
index 000000000..e04ee73cb
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-fsievaluator.html
@@ -0,0 +1,673 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FsiEvaluator (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                            
+    
                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                            
+    
                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                            
+
                                                                                                                                                            
+
+
                                                                                                                                                            
+    
                                                                                                                                                            
+        
                                                                                                                                                            
+  
                                                                                                                                                            
+    FsiEvaluator Type
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+    
                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                            
+    
                                                                                                                                                            
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                            
+    
                                                                                                                                                            
+      Base Type: 
+      obj
+    
                                                                                                                                                            
+    
                                                                                                                                                            
+      All Interfaces: 
+      IFsiEvaluator
+    
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+    
                                                                                                                                                            
+      
                                                                                                                                                            
+        
                                                                                                                                                            
+           A wrapper for F# interactive service that is used to evaluate inline snippets
+        
                                                                                                                                                            
+      
                                                                                                                                                            
+    
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+    
                                                                                                                                                            
+      Constructors
+    
                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                            
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                            
+            
                                                                                                                                                            
+              
+                
                                                                                                                                                            
+                  
+                    
+                      FsiEvaluator(?options, ?fsiObj, ?addHtmlPrinter, ?discardStdOut, ?disableFsiObj, ?onError)
+                    
+                  
+                
                                                                                                                                                            
+                                                                                                                                                                          
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  Full Usage: 
+                  FsiEvaluator(?options, ?fsiObj, ?addHtmlPrinter, ?discardStdOut, ?disableFsiObj, ?onError)
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                              
+                    
+                      
+                        ?options
+                      
+                      :
+                      string array
+                    
+                    
                                                                                                                                                              
+                    
+                      
+                        ?fsiObj
+                      
+                      :
+                      obj
+                    
+                    
                                                                                                                                                              
+                    
+                      
+                        ?addHtmlPrinter
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                              
+                    
+                      
+                        ?discardStdOut
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                              
+                    
+                      
+                        ?disableFsiObj
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                              
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                                                                                              
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  
+                    Returns: 
+                    FsiEvaluator
+                  
+                  
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+                                                                                                                                                                      		
+            
                                                                                                                                                            
+              
                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                            
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?options
+                  
+                  :
+                  string array
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?fsiObj
+                  
+                  :
+                  obj
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?addHtmlPrinter
+                  
+                  :
+                  bool
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?discardStdOut
+                  
+                  :
+                  bool
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?disableFsiObj
+                  
+                  :
+                  bool
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  FsiEvaluator
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+          
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+    
                                                                                                                                                            
+      Instance members
+    
                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                            
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                            
+            
                                                                                                                                                            
+              
+                
                                                                                                                                                            
+                  
+                    
+                      this.EvaluationFailed
+                    
+                  
+                
                                                                                                                                                            
+                                                                                                                                                                          
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  Full Usage: 
+                  this.EvaluationFailed
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  
+                    Returns: 
+                    IEvent<FsiEvaluationFailedInfo>
+                  
+                  
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+                                                                                                                                                                      		
+            
                                                                                                                                                            
+              
+                
                                                                                                                                                            
+                  
                                                                                                                                                            
+                    
                                                                                                                                                            
+                       This event is fired whenever an evaluation of an expression fails
+                    
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                    
+                      
+                    
+                    
                                                                                                                                                            
+                      
+                    
                                                                                                                                                            
+                    
                                                                                                                                                            
+                      
+                    
                                                                                                                                                            
+                  
                                                                                                                                                            
+                
                                                                                                                                                            
+                                                                                                                                                                          
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  IEvent<FsiEvaluationFailedInfo>
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+          
                                                                                                                                                            
+            
                                                                                                                                                            
+              
+                
                                                                                                                                                            
+                  
+                    
+                      this.RegisterTransformation
+                    
+                  
+                
                                                                                                                                                            
+                                                                                                                                                                          
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  Full Usage: 
+                  this.RegisterTransformation
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+                                                                                                                                                                      		
+            
                                                                                                                                                            
+              
+                
                                                                                                                                                            
+                  
                                                                                                                                                            
+                    
                                                                                                                                                            
+                       Register a function that formats (some) values that are produced by the evaluator.
+ The specified function should return 'Some' when it knows how to format a value
+ and it should return formatted
+                    
                                                                                                                                                            
+                  
                                                                                                                                                            
+                  
                                                                                                                                                            
+                    
+                      
+                    
+                    
                                                                                                                                                            
+                      
+                    
                                                                                                                                                            
+                    
                                                                                                                                                            
+                      
+                    
                                                                                                                                                            
+                  
                                                                                                                                                            
+                
                                                                                                                                                            
+                                                                                                                                                                          
+              
                                                                                                                                                            
+                
                                                                                                                                                            
+                  
+                    f
+                  
+                  :
+                  obj * Type * int -> MarkdownParagraph list option
+                
                                                                                                                                                            
+                
                                                                                                                                                            
+              
                                                                                                                                                            
+            
                                                                                                                                                            
+          
                                                                                                                                                            
+  
                                                                                                                                                            
+  
                                                                                                                                                            
+
                                                                                                                                                            
+        
+    
                                                                                                                                                            
+
                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                            
+        
                                                                                                                                                              
+        
                                                                                                                                                              Type something to start searching.
                                                                                                                                                              
+    
                                                                                                                                                              
+                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html b/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html
new file mode 100644
index 000000000..7ce072005
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-fsievaluatorconfig.html
@@ -0,0 +1,498 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FsiEvaluatorConfig (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                              
+    
                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                              
+    
                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                              
+
                                                                                                                                                              
+
+
                                                                                                                                                              
+    
                                                                                                                                                              
+        
                                                                                                                                                              
+  
                                                                                                                                                              
+    FsiEvaluatorConfig Type
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+    
                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                              
+    
                                                                                                                                                              
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                              
+    
                                                                                                                                                              
+      Base Type: 
+      obj
+    
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+    
                                                                                                                                                              
+      
                                                                                                                                                              
+        
                                                                                                                                                              
+           Provides configuration options for the FsiEvaluator
+        
                                                                                                                                                              
+      
                                                                                                                                                              
+    
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+    
                                                                                                                                                              
+      Constructors
+    
                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                              
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                              
+            
                                                                                                                                                              
+              
+                
                                                                                                                                                              
+                  
+                    
+                      FsiEvaluatorConfig()
+                    
+                  
+                
                                                                                                                                                              
+                                                                                                                                                                            
+              
                                                                                                                                                              
+                
                                                                                                                                                              
+                  Full Usage: 
+                  FsiEvaluatorConfig()
+                  
                                                                                                                                                              
+                  
                                                                                                                                                              
+                  
+                    Returns: 
+                    FsiEvaluatorConfig
+                  
+                  
                                                                                                                                                              
+                
                                                                                                                                                              
+              
                                                                                                                                                              
+            
                                                                                                                                                              
+                                                                                                                                                                        		
+            
                                                                                                                                                              
+              
                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                              
+              
                                                                                                                                                              
+                
                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  FsiEvaluatorConfig
+                
                                                                                                                                                              
+                
                                                                                                                                                              
+              
                                                                                                                                                              
+            
                                                                                                                                                              
+          
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+  
                                                                                                                                                              
+    
                                                                                                                                                              
+      Static members
+    
                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                              
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                              
+            
                                                                                                                                                              
+              
+                
                                                                                                                                                              
+                  
+                    
+                      FsiEvaluatorConfig.CreateNoOpFsiObject()
+                    
+                  
+                
                                                                                                                                                              
+                                                                                                                                                                            
+              
                                                                                                                                                              
+                
                                                                                                                                                              
+                  Full Usage: 
+                  FsiEvaluatorConfig.CreateNoOpFsiObject()
+                  
                                                                                                                                                              
+                  
                                                                                                                                                              
+                  
+                    Returns: 
+                    obj
+                  
+                  
                                                                                                                                                              
+                
                                                                                                                                                              
+              
                                                                                                                                                              
+            
                                                                                                                                                              
+                                                                                                                                                                        		
+            
                                                                                                                                                              
+              
+                
                                                                                                                                                              
+                  
                                                                                                                                                              
+                    
                                                                                                                                                              
+                       Creates a dummy fsi object that does not affect the behaviour of F# Interactive
+ (and simply ignores all operations that are done on it). You can use this to
+ e.g. disable registered printers that would open new windows etc.
+                    
                                                                                                                                                              
+                  
                                                                                                                                                              
+                  
                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                              
+                      
+                    
                                                                                                                                                              
+                    
                                                                                                                                                              
+                      
+                    
                                                                                                                                                              
+                  
                                                                                                                                                              
+                
                                                                                                                                                              
+                                                                                                                                                                            
+              
                                                                                                                                                              
+                
                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  obj
+                
                                                                                                                                                              
+                
                                                                                                                                                              
+              
                                                                                                                                                              
+            
                                                                                                                                                              
+          
                                                                                                                                                              
+  
                                                                                                                                                              
+
                                                                                                                                                              
+        
+    
                                                                                                                                                              
+
                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                              
+        
                                                                                                                                                                
+        
                                                                                                                                                                Type something to start searching.
                                                                                                                                                                
+    
                                                                                                                                                                
+                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-ifsievaluationresult.html b/reference/fsharp-formatting-literate-evaluation-ifsievaluationresult.html
new file mode 100644
index 000000000..8dc02cc57
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-ifsievaluationresult.html
@@ -0,0 +1,347 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    IFsiEvaluationResult (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                
+    
                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                
+    
                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                
+
                                                                                                                                                                
+
+
                                                                                                                                                                
+    
                                                                                                                                                                
+        
                                                                                                                                                                
+  
                                                                                                                                                                
+    IFsiEvaluationResult Type
+  
                                                                                                                                                                
+  
                                                                                                                                                                
+    
                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                                
+    
                                                                                                                                                                
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                
+    
                                                                                                                                                                
+      Base Type: 
+      obj
+    
                                                                                                                                                                
+    
                                                                                                                                                                
+      All Interfaces: 
+      IFsiEvaluationResult
+    
                                                                                                                                                                
+  
                                                                                                                                                                
+  
                                                                                                                                                                
+    
                                                                                                                                                                
+      
                                                                                                                                                                
+        
                                                                                                                                                                
+           An interface that represents FSI evaluation result
+ (we make this abstract so that evaluators can store other info)
+        
                                                                                                                                                                
+      
                                                                                                                                                                
+    
                                                                                                                                                                
+  
                                                                                                                                                                
+
                                                                                                                                                                
+        
+    
                                                                                                                                                                
+
                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                
+        
                                                                                                                                                                  
+        
                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                  
+    
                                                                                                                                                                  
+                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html b/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html
new file mode 100644
index 000000000..8e8a31575
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation-ifsievaluator.html
@@ -0,0 +1,610 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    IFsiEvaluator (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                  
+    
                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                  
+    
                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                  
+
                                                                                                                                                                  
+
+
                                                                                                                                                                  
+    
                                                                                                                                                                  
+        
                                                                                                                                                                  
+  
                                                                                                                                                                  
+    IFsiEvaluator Type
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Literate.Evaluation
+      
+    
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      Base Type: 
+      obj
+    
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      All Interfaces: 
+      IFsiEvaluator
+    
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      
                                                                                                                                                                  
+        
                                                                                                                                                                  
+           Represents an evaluator for F# snippets embedded in code
+        
                                                                                                                                                                  
+      
                                                                                                                                                                  
+    
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+    
                                                                                                                                                                  
+      Instance members
+    
                                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                  
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                  
+            
                                                                                                                                                                  
+              
+                
                                                                                                                                                                  
+                  
+                    
+                      this.Evaluate
+                    
+                  
+                
                                                                                                                                                                  
+                                                                                                                                                                                
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  Full Usage: 
+                  this.Evaluate
+                  
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                    
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                    
+                    
+                      
+                        asExpression
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                    
+                    
+                      
+                        file
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                    
+                  
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                  
+                    Returns: 
+                    IFsiEvaluationResult
+                  
+                  
                                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+            
                                                                                                                                                                  
+                                                                                                                                                                            		
+            
                                                                                                                                                                  
+              
+                
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                    
                                                                                                                                                                  
+                       Called to evaluate a snippet
+                    
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                    
+                      
+                    
+                    
                                                                                                                                                                  
+                      
+                    
                                                                                                                                                                  
+                    
                                                                                                                                                                  
+                      
+                    
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                                                                                                                                                                                
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    asExpression
+                  
+                  :
+                  bool
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    file
+                  
+                  :
+                  string option
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  IFsiEvaluationResult
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+            
                                                                                                                                                                  
+          
                                                                                                                                                                  
+            
                                                                                                                                                                  
+              
+                
                                                                                                                                                                  
+                  
+                    
+                      this.Format
+                    
+                  
+                
                                                                                                                                                                  
+                                                                                                                                                                                
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  Full Usage: 
+                  this.Format
+                  
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                  Parameters: 
+                  
+                  
                                                                                                                                                                  
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                  
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+            
                                                                                                                                                                  
+                                                                                                                                                                            		
+            
                                                                                                                                                                  
+              
+                
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                    
                                                                                                                                                                  
+                       Called to format some part of evaluation result generated by FSI
+                    
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                    
+                      
+                    
+                    
                                                                                                                                                                  
+                      
+                    
                                                                                                                                                                  
+                    
                                                                                                                                                                  
+                      
+                    
                                                                                                                                                                  
+                  
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                                                                                                                                                                                
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    result
+                  
+                  :
+                  IFsiEvaluationResult
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    kind
+                  
+                  :
+                  FsiEmbedKind
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    executionCount
+                  
+                  :
+                  int
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+              
                                                                                                                                                                  
+                
                                                                                                                                                                  
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                  
+                
                                                                                                                                                                  
+              
                                                                                                                                                                  
+            
                                                                                                                                                                  
+          
                                                                                                                                                                  
+  
                                                                                                                                                                  
+  
                                                                                                                                                                  
+
                                                                                                                                                                  
+        
+    
                                                                                                                                                                  
+
                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                  
+        
                                                                                                                                                                    
+        
                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                    
+    
                                                                                                                                                                    
+                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-evaluation.html b/reference/fsharp-formatting-literate-evaluation.html
new file mode 100644
index 000000000..0067b6566
--- /dev/null
+++ b/reference/fsharp-formatting-literate-evaluation.html
@@ -0,0 +1,559 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.Literate.Evaluation | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                    
+    
                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                    
+    
                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                    
+
                                                                                                                                                                    
+
+
                                                                                                                                                                    
+    
                                                                                                                                                                    
+        
                                                                                                                                                                    
+  
                                                                                                                                                                    
+    FSharp.Formatting.Literate.Evaluation Namespace
+  
                                                                                                                                                                    
+  
                                                                                                                                                                    
+    
                                                                                                                                                                    
+      Functionality to support literate evaluation for F# scripts
+    
                                                                                                                                                                    
+  
                                                                                                                                                                    
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                                    
+          Type
+        
+          Description
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                FsiEmbedKind
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+   Represents a kind of thing that can be embedded
+ 
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                FsiEvaluationFailedInfo
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 Record that is reported by the EvaluationFailed event when something
+ goes wrong during evalutaiton of an expression
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                FsiEvaluationResult
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 Represents the result of evaluating an F# snippet. This contains
+ the generated console output together with a result and its static type.
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                FsiEvaluator
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 A wrapper for F# interactive service that is used to evaluate inline snippets
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                FsiEvaluatorConfig
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 Provides configuration options for the FsiEvaluator
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                IFsiEvaluationResult
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 An interface that represents FSI evaluation result
+ (we make this abstract so that evaluators can store other info)
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+          
                                                                                                                                                                    
+            
+              
+                IFsiEvaluator
+              
+            
+          
                                                                                                                                                                    
+                                                                                                                                                                            		
+          
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                 Represents an evaluator for F# snippets embedded in code
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+            
                                                                                                                                                                    
+              
+                
+              
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+              
                                                                                                                                                                    
+                
+              
                                                                                                                                                                    
+            
                                                                                                                                                                    
+          
                                                                                                                                                                    
+        
                                                                                                                                                                    
+
                                                                                                                                                                    
+        
+    
                                                                                                                                                                    
+
                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                    
+        
                                                                                                                                                                      
+        
                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                      
+    
                                                                                                                                                                      
+                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-indextext.html b/reference/fsharp-formatting-literate-indextext.html
new file mode 100644
index 000000000..f8dc3e58c
--- /dev/null
+++ b/reference/fsharp-formatting-literate-indextext.html
@@ -0,0 +1,452 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    IndexText (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                      
+    
                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                      
+    
                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                      
+
                                                                                                                                                                      
+
+
                                                                                                                                                                      
+    
                                                                                                                                                                      
+        
                                                                                                                                                                      
+  
                                                                                                                                                                      
+    IndexText Type
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      Base Type: 
+      obj
+    
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      All Interfaces: 
+      IEquatable<IndexText>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<IndexText>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      
                                                                                                                                                                      
+        
                                                                                                                                                                      
+          
+        
                                                                                                                                                                      
+      
                                                                                                                                                                      
+    
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+    
                                                                                                                                                                      
+      Union cases
+    
                                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                      
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                      
+            
                                                                                                                                                                      
+              
+                
                                                                                                                                                                      
+                  
+                    
+                      IndexText(fullContent, headings)
+                    
+                  
+                
                                                                                                                                                                      
+                                                                                                                                                                                    
+              
                                                                                                                                                                      
+                
                                                                                                                                                                      
+                  Full Usage: 
+                  IndexText(fullContent, headings)
+                  
                                                                                                                                                                      
+                  
                                                                                                                                                                      
+                  Parameters: 
+                  
                                                                                                                                                                        
+                    
+                      
+                        fullContent
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                        
+                    
+                      
+                        headings
+                      
+                      :
+                      string list
+                    
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                      
+                  
                                                                                                                                                                      
+                
                                                                                                                                                                      
+              
                                                                                                                                                                      
+            
                                                                                                                                                                      
+                                                                                                                                                                                		
+            
                                                                                                                                                                      
+              
                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                      
+              
                                                                                                                                                                      
+                
                                                                                                                                                                      
+                  
+                    fullContent
+                  
+                  :
+                  string
+                
                                                                                                                                                                      
+                
                                                                                                                                                                      
+                
                                                                                                                                                                      
+                  
+                    headings
+                  
+                  :
+                  string list
+                
                                                                                                                                                                      
+                
                                                                                                                                                                      
+              
                                                                                                                                                                      
+            
                                                                                                                                                                      
+          
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+  
                                                                                                                                                                      
+
                                                                                                                                                                      
+        
+    
                                                                                                                                                                      
+
                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                      
+        
                                                                                                                                                                        
+        
                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                        
+    
                                                                                                                                                                        
+                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literate.html b/reference/fsharp-formatting-literate-literate.html
new file mode 100644
index 000000000..57f5c7943
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literate.html
@@ -0,0 +1,3173 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Literate (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                        
+    
                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                        
+    
                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                        
+
                                                                                                                                                                        
+
+
                                                                                                                                                                        
+    
                                                                                                                                                                        
+        
                                                                                                                                                                        
+  
                                                                                                                                                                        
+    Literate Type
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+    
                                                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                        
+    
                                                                                                                                                                        
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                        
+    
                                                                                                                                                                        
+      Base Type: 
+      obj
+    
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+    
                                                                                                                                                                        
+      
                                                                                                                                                                        
+        
                                                                                                                                                                        
+          
+ This type provides three simple methods for calling the literate programming tool.
+ The ConvertMarkdownFile and ConvertScriptFile methods process a single Markdown document
+ and F# script, respectively. The ConvertDirectory method handles an entire directory tree
+ (looking for *.fsx and *.md files).
+ 
+        
                                                                                                                                                                        
+      
                                                                                                                                                                        
+    
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+  
                                                                                                                                                                        
+    
                                                                                                                                                                        
+      Static members
+    
                                                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                        
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ConvertMarkdownFile(input, ?template, ?output, ?outputKind, ?prefix, ?fscOptions, ?lineNumbers, ?references, ?substitutions, ?generateAnchors, ?imageSaver, ?rootInputFolder, ?crefResolver, ?mdlinkResolver, ?onError, ?filesWithFrontMatter)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ConvertMarkdownFile(input, ?template, ?output, ?outputKind, ?prefix, ?fscOptions, ?lineNumbers, ?references, ?substitutions, ?generateAnchors, ?imageSaver, ?rootInputFolder, ?crefResolver, ?mdlinkResolver, ?onError, ?filesWithFrontMatter)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?template
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?output
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?outputKind
+                      
+                      :
+                      OutputKind
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?imageSaver
+                      
+                      :
+                      string -> string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?filesWithFrontMatter
+                      
+                      :
+                      FrontMatterFile array
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Convert a markdown file into HTML or another output kind
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?template
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?output
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?outputKind
+                  
+                  :
+                  OutputKind
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?imageSaver
+                  
+                  :
+                  string -> string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?filesWithFrontMatter
+                  
+                  :
+                  FrontMatterFile array
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ConvertScriptFile(input, ?template, ?output, ?outputKind, ?prefix, ?fscOptions, ?lineNumbers, ?references, ?fsiEvaluator, ?substitutions, ?generateAnchors, ?imageSaver, ?rootInputFolder, ?crefResolver, ?mdlinkResolver, ?onError, ?filesWithFrontMatter)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ConvertScriptFile(input, ?template, ?output, ?outputKind, ?prefix, ?fscOptions, ?lineNumbers, ?references, ?fsiEvaluator, ?substitutions, ?generateAnchors, ?imageSaver, ?rootInputFolder, ?crefResolver, ?mdlinkResolver, ?onError, ?filesWithFrontMatter)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        input
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?template
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?output
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?outputKind
+                      
+                      :
+                      OutputKind
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fsiEvaluator
+                      
+                      :
+                      IFsiEvaluator
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?imageSaver
+                      
+                      :
+                      string -> string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?filesWithFrontMatter
+                      
+                      :
+                      FrontMatterFile array
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      Convert a script file into HTML or another output kind
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    input
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?template
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?output
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?outputKind
+                  
+                  :
+                  OutputKind
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fsiEvaluator
+                  
+                  :
+                  IFsiEvaluator
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?imageSaver
+                  
+                  :
+                  string -> string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?filesWithFrontMatter
+                  
+                  :
+                  FrontMatterFile array
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                Example
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                             Literate.ConvertScriptFile("script.fsx", template)
+
                                                                                                                                                                        
+
+
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ParseAndCheckScriptFile(path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ParseAndCheckScriptFile(path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        path
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?definedSymbols
+                      
+                      :
+                      string list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fsiEvaluator
+                      
+                      :
+                      IFsiEvaluator
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Parse F# Script file to LiterateDocument
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    path
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?definedSymbols
+                  
+                  :
+                  string list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fsiEvaluator
+                  
+                  :
+                  IFsiEvaluator
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ParseMarkdownFile(path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ParseMarkdownFile(path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        path
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?definedSymbols
+                      
+                      :
+                      string list
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fsiEvaluator
+                      
+                      :
+                      IFsiEvaluator
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                       - 
+                      Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+  Parse Markdown document to LiterateDocument
+ 
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    path
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?definedSymbols
+                  
+                  :
+                  string list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fsiEvaluator
+                  
+                  :
+                  IFsiEvaluator
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ParseMarkdownString(content, ?path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ParseMarkdownString(content, ?path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        content
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?path
+                      
+                      :
+                      string
+                       - 
+                      optional file path for debugging purposes
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?definedSymbols
+                      
+                      :
+                      string list
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fsiEvaluator
+                      
+                      :
+                      IFsiEvaluator
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                       - 
+                      Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+  Parse string as a markdown document
+ 
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    content
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?path
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    optional file path for debugging purposes
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?definedSymbols
+                  
+                  :
+                  string list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fsiEvaluator
+                  
+                  :
+                  IFsiEvaluator
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ParsePynbString(content, ?path, ?definedSymbols, ?references, ?parseOptions, ?rootInputFolder, ?onError)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ParsePynbString(content, ?path, ?definedSymbols, ?references, ?parseOptions, ?rootInputFolder, ?onError)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        content
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?path
+                      
+                      :
+                      string
+                       - 
+                      optional file path for debugging purposes
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?definedSymbols
+                      
+                      :
+                      string list
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                       - 
+                      Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                       - 
+                      
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+ Parse pynb string as literate document
+ 
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    content
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?path
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    optional file path for debugging purposes
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?definedSymbols
+                  
+                  :
+                  string list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    Defaults to MarkdownParseOptions.AllowYamlFrontMatter
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ParseScriptString(content, ?path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ParseScriptString(content, ?path, ?fscOptions, ?definedSymbols, ?references, ?fsiEvaluator, ?parseOptions, ?rootInputFolder, ?onError)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        content
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?path
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fscOptions
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?definedSymbols
+                      
+                      :
+                      string list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?references
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?fsiEvaluator
+                      
+                      :
+                      IFsiEvaluator
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?onError
+                      
+                      :
+                      string -> unit
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Parse string as F# Script to LiterateDocument
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    content
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?path
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fscOptions
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?definedSymbols
+                  
+                  :
+                  string list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?references
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?fsiEvaluator
+                  
+                  :
+                  IFsiEvaluator
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?onError
+                  
+                  :
+                  string -> unit
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ToFsx(doc, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ToFsx(doc, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Formate the literate document as an .fsx script
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ToHtml(doc, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver, ?tokenKindToCss)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ToHtml(doc, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver, ?tokenKindToCss)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?tokenKindToCss
+                      
+                      :
+                      TokenKind -> string
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Format the literate document as HTML without using a template
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?tokenKindToCss
+                  
+                  :
+                  TokenKind -> string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ToLatex(doc, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ToLatex(doc, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Format the literate document as Latex without using a template
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.ToPynb(doc, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.ToPynb(doc, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Formate the literate document as an iPython notebook
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.WriteHtml(doc, writer, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver, ?tokenKindToCss)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.WriteHtml(doc, writer, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver, ?tokenKindToCss)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?tokenKindToCss
+                      
+                      :
+                      TokenKind -> string
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Write the literate document as HTML without using a template
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?tokenKindToCss
+                  
+                  :
+                  TokenKind -> string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
+                    
+                      Literate.WriteLatex(doc, writer, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  Full Usage: 
+                  Literate.WriteLatex(doc, writer, ?prefix, ?lineNumbers, ?generateAnchors, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  Parameters: 
+                  
                                                                                                                                                                          
+                    
+                      
+                        doc
+                      
+                      :
+                      LiterateDocument
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?prefix
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                          
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+                                                                                                                                                                                  		
+            
                                                                                                                                                                        
+              
+                
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                       Write the literate document as Latex without using a template
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                    
+                      
+                    
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                    
                                                                                                                                                                        
+                      
+                    
                                                                                                                                                                        
+                  
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                                                                                                                                                                                      
+              
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    doc
+                  
+                  :
+                  LiterateDocument
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?prefix
+                  
+                  :
+                  string
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                        
+                
                                                                                                                                                                        
+              
                                                                                                                                                                        
+            
                                                                                                                                                                        
+          
                                                                                                                                                                        
+  
                                                                                                                                                                        
+
                                                                                                                                                                        
+        
+    
                                                                                                                                                                        
+
                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                        
+        
                                                                                                                                                                          
+        
                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                          
+    
                                                                                                                                                                          
+                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literatecodeoptions.html b/reference/fsharp-formatting-literate-literatecodeoptions.html
new file mode 100644
index 000000000..3163a9feb
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literatecodeoptions.html
@@ -0,0 +1,610 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateCodeOptions (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                          
+    
                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                          
+    
                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                          
+
                                                                                                                                                                          
+
+
                                                                                                                                                                          
+    
                                                                                                                                                                          
+        
                                                                                                                                                                          
+  
                                                                                                                                                                          
+    LiterateCodeOptions Type
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      All Interfaces: 
+      IEquatable<LiterateCodeOptions>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<LiterateCodeOptions>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      
                                                                                                                                                                          
+        
                                                                                                                                                                          
+          
+ Additional properties of a literate code snippet, embedded in a
+ LiterateParagraph.LiterateCode. The properties specify how should
+ a snippet be evaluated and formatted.
+ 
+        
                                                                                                                                                                          
+      
                                                                                                                                                                          
+    
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+    
                                                                                                                                                                          
+      Record fields
+    
                                                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                          
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                                          
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
+                    
+                      Evaluate
+                    
+                  
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  Full Usage: 
+                  Evaluate
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
+                    Field type: 
+                    bool
+                  
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+                                                                                                                                                                                    		
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
                                                                                                                                                                          
+                      
+ Specifies whether the snippet is evalauted while processing
+ Use (*** do-not-eval ***) command to set this to false
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
+                      
+                    
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  bool
+                
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+          
                                                                                                                                                                          
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
+                    
+                      ExecutionCount
+                    
+                  
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  Full Usage: 
+                  ExecutionCount
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
+                    Field type: 
+                    int option
+                  
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+                                                                                                                                                                                    		
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
                                                                                                                                                                          
+                       Indiciates the execution sequence number of the cell if it has been evaluated
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
+                      
+                    
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  int option
+                
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+          
                                                                                                                                                                          
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
+                    
+                      OutputName
+                    
+                  
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  Full Usage: 
+                  OutputName
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+                                                                                                                                                                                    		
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
                                                                                                                                                                          
+                       Specifies the name of the output produced by this snippet
+ Use the (*** define-output:foo ***) command to set this value
+ Other outputs are named cell1, cell2 etc.
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
+                      
+                    
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+          
                                                                                                                                                                          
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
+                    
+                      Visibility
+                    
+                  
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  Full Usage: 
+                  Visibility
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
+                    Field type: 
+                    LiterateCodeVisibility
+                  
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+                                                                                                                                                                                    		
+            
                                                                                                                                                                          
+              
+                
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
                                                                                                                                                                          
+                       Specifies the visibility of the snippet in the generated HTML
+                    
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                  
                                                                                                                                                                          
+                    
+                      
+                    
+                  
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                                                                                                                                                                                        
+              
                                                                                                                                                                          
+                
                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  LiterateCodeVisibility
+                
                                                                                                                                                                          
+                
                                                                                                                                                                          
+              
                                                                                                                                                                          
+            
                                                                                                                                                                          
+          
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+  
                                                                                                                                                                          
+
                                                                                                                                                                          
+        
+    
                                                                                                                                                                          
+
                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                          
+        
                                                                                                                                                                            
+        
                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                            
+    
                                                                                                                                                                            
+                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literatecodevisibility.html b/reference/fsharp-formatting-literate-literatecodevisibility.html
new file mode 100644
index 000000000..327ad9a9e
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literatecodevisibility.html
@@ -0,0 +1,519 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateCodeVisibility (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                            
+    
                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                            
+    
                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                            
+
                                                                                                                                                                            
+
+
                                                                                                                                                                            
+    
                                                                                                                                                                            
+        
                                                                                                                                                                            
+  
                                                                                                                                                                            
+    LiterateCodeVisibility Type
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      Base Type: 
+      obj
+    
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      All Interfaces: 
+      IEquatable<LiterateCodeVisibility>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<LiterateCodeVisibility>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      
                                                                                                                                                                            
+        
                                                                                                                                                                            
+           Specifies visibility of a code snippet.
+        
                                                                                                                                                                            
+      
                                                                                                                                                                            
+    
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+    
                                                                                                                                                                            
+      Union cases
+    
                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                            
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                            
+            
                                                                                                                                                                            
+              
+                
                                                                                                                                                                            
+                  
+                    
+                      HiddenCode
+                    
+                  
+                
                                                                                                                                                                            
+                                                                                                                                                                                          
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                  Full Usage: 
+                  HiddenCode
+                  
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+                                                                                                                                                                                      		
+            
                                                                                                                                                                            
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                   Hidden snippet
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+              
                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+          
                                                                                                                                                                            
+            
                                                                                                                                                                            
+              
+                
                                                                                                                                                                            
+                  
+                    
+                      NamedCode string
+                    
+                  
+                
                                                                                                                                                                            
+                                                                                                                                                                                          
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                  Full Usage: 
+                  NamedCode string
+                  
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                              
+                    
+                      
+                        Item
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+                                                                                                                                                                                      		
+            
                                                                                                                                                                            
+              
+                
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                    
                                                                                                                                                                            
+                       Named snippet with captured output
+                    
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                                                                                                                                                                                          
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                  
+                    Item
+                  
+                  :
+                  string
+                
                                                                                                                                                                            
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+          
                                                                                                                                                                            
+            
                                                                                                                                                                            
+              
+                
                                                                                                                                                                            
+                  
+                    
+                      VisibleCode
+                    
+                  
+                
                                                                                                                                                                            
+                                                                                                                                                                                          
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                  Full Usage: 
+                  VisibleCode
+                  
                                                                                                                                                                            
+                  
                                                                                                                                                                            
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+                                                                                                                                                                                      		
+            
                                                                                                                                                                            
+              
                                                                                                                                                                            
+                
                                                                                                                                                                            
+                   Ordinary visible code
+                
                                                                                                                                                                            
+              
                                                                                                                                                                            
+              
                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                            
+            
                                                                                                                                                                            
+          
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+  
                                                                                                                                                                            
+
                                                                                                                                                                            
+        
+    
                                                                                                                                                                            
+
                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                            
+        
                                                                                                                                                                              
+        
                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                              
+    
                                                                                                                                                                              
+                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literatedocument.html b/reference/fsharp-formatting-literate-literatedocument.html
new file mode 100644
index 000000000..0e23b94b0
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literatedocument.html
@@ -0,0 +1,1221 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateDocument (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                              
+    
                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                              
+    
                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                              
+
                                                                                                                                                                              
+
+
                                                                                                                                                                              
+    
                                                                                                                                                                              
+        
                                                                                                                                                                              
+  
                                                                                                                                                                              
+    LiterateDocument Type
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      Base Type: 
+      obj
+    
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      
                                                                                                                                                                              
+        
                                                                                                                                                                              
+           Representation of a literate document - the representation of Paragraphs
+ uses an F# discriminated union type and so is best used from F#.
+        
                                                                                                                                                                              
+      
                                                                                                                                                                              
+    
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      Constructors
+    
                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                              
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      LiterateDocument(paragraphs, formattedTips, links, source, sourceFile, rootInputFolder, diagnostics)
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  LiterateDocument(paragraphs, formattedTips, links, source, sourceFile, rootInputFolder, diagnostics)
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  Parameters: 
+                  
                                                                                                                                                                                
+                    
+                      
+                        paragraphs
+                      
+                      :
+                      MarkdownParagraphs
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        formattedTips
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        links
+                      
+                      :
+                      IDictionary<string, (string * string option)>
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        source
+                      
+                      :
+                      LiterateSource
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        sourceFile
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        rootInputFolder
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        diagnostics
+                      
+                      :
+                      SourceError array
+                    
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                              
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    paragraphs
+                  
+                  :
+                  MarkdownParagraphs
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    formattedTips
+                  
+                  :
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    links
+                  
+                  :
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    source
+                  
+                  :
+                  LiterateSource
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    sourceFile
+                  
+                  :
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    rootInputFolder
+                  
+                  :
+                  string option
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    diagnostics
+                  
+                  :
+                  SourceError array
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+    
                                                                                                                                                                              
+      Instance members
+    
                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                              
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.DefinedLinks
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.DefinedLinks
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    IDictionary<string, (string * string option)>
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Returns a dictionary containing explicitly defined links
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.Diagnostics
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.Diagnostics
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    SourceError array
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Errors
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  SourceError array
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.FormattedTips
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.FormattedTips
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Formatted tool tips
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.MarkdownDocument
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.MarkdownDocument
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownDocument
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Return as markdown document, throwing away additional stuff
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownDocument
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.Paragraphs
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.Paragraphs
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Returns a list of paragraphs in the document
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.RootInputFolder
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.RootInputFolder
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    string option
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Root for computing relative paths
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string option
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.Source
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.Source
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    LiterateSource
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Original document source code
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  LiterateSource
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.SourceFile
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.SourceFile
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Location where the file was loaded from
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
+                    
+                      this.With
+                    
+                  
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  Full Usage: 
+                  this.With
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  Parameters: 
+                  
                                                                                                                                                                                
+                    
+                      
+                        ?paragraphs
+                      
+                      :
+                      MarkdownParagraphs
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?formattedTips
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?definedLinks
+                      
+                      :
+                      IDictionary<string, (string * string option)>
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?source
+                      
+                      :
+                      LiterateSource
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?sourceFile
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?rootInputFolder
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                                
+                    
+                      
+                        ?diagnostics
+                      
+                      :
+                      SourceError array
+                    
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
+                    Returns: 
+                    LiterateDocument
+                  
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+                                                                                                                                                                                        		
+            
                                                                                                                                                                              
+              
+                
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                       Clone the document and change some of its properties
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                    
                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                              
+                  
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                                                                                                                                                                                            
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?paragraphs
+                  
+                  :
+                  MarkdownParagraphs
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?formattedTips
+                  
+                  :
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?definedLinks
+                  
+                  :
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?source
+                  
+                  :
+                  LiterateSource
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?sourceFile
+                  
+                  :
+                  string
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?rootInputFolder
+                  
+                  :
+                  string option
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    ?diagnostics
+                  
+                  :
+                  SourceError array
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+              
                                                                                                                                                                              
+                
                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  LiterateDocument
+                
                                                                                                                                                                              
+                
                                                                                                                                                                              
+              
                                                                                                                                                                              
+            
                                                                                                                                                                              
+          
                                                                                                                                                                              
+  
                                                                                                                                                                              
+  
                                                                                                                                                                              
+
                                                                                                                                                                              
+        
+    
                                                                                                                                                                              
+
                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                              
+        
                                                                                                                                                                                
+        
                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                
+    
                                                                                                                                                                                
+                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literateparagraph.html b/reference/fsharp-formatting-literate-literateparagraph.html
new file mode 100644
index 000000000..02bfe2acd
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literateparagraph.html
@@ -0,0 +1,1280 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateParagraph (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                
+    
                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                
+    
                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
                                                                                                                                                                                
+    
                                                                                                                                                                                
+        
                                                                                                                                                                                
+  
                                                                                                                                                                                
+    LiterateParagraph Type
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      Base Type: 
+      obj
+    
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      All Interfaces: 
+      IEquatable<LiterateParagraph>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<LiterateParagraph>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      MarkdownEmbedParagraphs
+    
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      
                                                                                                                                                                                
+        
                                                                                                                                                                                
+          
+ Extends MarkdownParagrap using the MarkdownEmbedParagraphs case with
+ additional kinds of paragraphs that can appear in literate F# scripts
+ (such as various special commands to embed output of a snippet etc.)
+ 
+        
                                                                                                                                                                                
+      
                                                                                                                                                                                
+    
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      Union cases
+    
                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      CodeReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  CodeReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include:foo ***) - Include formatted snippet from other part of the document here
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      FsiMergedOutputReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  FsiMergedOutputReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-fsi-merged-output ***) - Include output from previous snippet
+ (*** include-fsi-merged-output:foo ***) - Include output from a named snippet
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      FsiOutputReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  FsiOutputReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-fsi-output ***) - Include output from previous snippet
+ (*** include-fsi-output:foo ***) - Include output from a named snippet
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      ItRawReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  ItRawReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-it-raw ***) - Include "it" value from the subsequent snippet here as raw text (Not formatted as fsi)
+ (*** include-it-raw:foo ***) - Include "it" value from a named snippet as raw text (Not formatted as fsi)
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      ItValueReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  ItValueReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-it ***) - Include "it" value from the subsequent snippet here
+ (*** include-it:foo ***) - Include "it" value from a named snippet
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      LanguageTaggedCode(language, code, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  LanguageTaggedCode(language, code, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                  
+                    
+                      
+                        language
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                  
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                  
+                    
+                      
+                        paragraphOptions
+                      
+                      :
+                      LiterateParagraphOptions
+                    
+                    
                                                                                                                                                                                  
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       Ordinary formatted code snippet in non-F# language (tagged with language code)
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    language
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      LiterateCode(lines, options, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  LiterateCode(lines, options, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       Embedded literate code snippet. Consists of source lines and options
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    lines
+                  
+                  :
+                  Line list
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    options
+                  
+                  :
+                  LiterateCodeOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      OutputReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  OutputReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-fsi-output ***) - Include F# Interactive output from previous snippet
+ (*** include-fsi-output:foo ***) - Include F# Interactive from a named snippet
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      RawBlock(lines, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  RawBlock(lines, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       Block simply emitted without any formatting equivalent to 
                                                                                                                                                                                 tag in html
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    lines
+                  
+                  :
+                  Line list
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      ValueReference(ref, paragraphOptions)
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  ValueReference(ref, paragraphOptions)
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
                                                                                                                                                                                
+                       (*** include-value:foo ***) - Include the formatting of a specified value here
+                    
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                    
+                      
+                    
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    ref
+                  
+                  :
+                  string
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    paragraphOptions
+                  
+                  :
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+    
                                                                                                                                                                                
+      Instance members
+    
                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                
+            
                                                                                                                                                                                
+              
+                
                                                                                                                                                                                
+                  
+                    
+                      this.ParagraphOptions
+                    
+                  
+                
                                                                                                                                                                                
+                                                                                                                                                                                              
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  Full Usage: 
+                  this.ParagraphOptions
+                  
                                                                                                                                                                                
+                  
                                                                                                                                                                                
+                  
+                    Returns: 
+                    LiterateParagraphOptions
+                  
+                  
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+                                                                                                                                                                                          		
+            
                                                                                                                                                                                
+              
                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                
+              
                                                                                                                                                                                
+                
                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  LiterateParagraphOptions
+                
                                                                                                                                                                                
+                
                                                                                                                                                                                
+              
                                                                                                                                                                                
+            
                                                                                                                                                                                
+          
                                                                                                                                                                                
+  
                                                                                                                                                                                
+  
                                                                                                                                                                                
+
                                                                                                                                                                                
+        
+    
                                                                                                                                                                                
+
                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                
+        
                                                                                                                                                                                  
+        
                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literateparagraphoptions.html b/reference/fsharp-formatting-literate-literateparagraphoptions.html
new file mode 100644
index 000000000..aa8c18eb3
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literateparagraphoptions.html
@@ -0,0 +1,437 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateParagraphOptions (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                  
+
                                                                                                                                                                                  
+
+
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+        
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+    LiterateParagraphOptions Type
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      Base Type: 
+      obj
+    
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      All Interfaces: 
+      IEquatable<LiterateParagraphOptions>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<LiterateParagraphOptions>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      
                                                                                                                                                                                  
+        
                                                                                                                                                                                  
+           Specifies the options for a literate paragraph
+        
                                                                                                                                                                                  
+      
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+    
                                                                                                                                                                                  
+      Record fields
+    
                                                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                  
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                                                  
+            
                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                  
+                  
+                    
+                      Condition
+                    
+                  
+                
                                                                                                                                                                                  
+                                                                                                                                                                                                
+              
                                                                                                                                                                                  
+                
                                                                                                                                                                                  
+                  Full Usage: 
+                  Condition
+                  
                                                                                                                                                                                  
+                  
                                                                                                                                                                                  
+                  
+                    Field type: 
+                    string option
+                  
+                  
                                                                                                                                                                                  
+                
                                                                                                                                                                                  
+              
                                                                                                                                                                                  
+            
                                                                                                                                                                                  
+                                                                                                                                                                                            		
+            
                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                  
+                  
                                                                                                                                                                                  
+                    
                                                                                                                                                                                  
+                       Specifies a conditional for inclusion of the snippet paragraph
+                    
                                                                                                                                                                                  
+                  
                                                                                                                                                                                  
+                  
                                                                                                                                                                                  
+                    
+                      
+                    
+                  
                                                                                                                                                                                  
+                
                                                                                                                                                                                  
+                                                                                                                                                                                                
+              
                                                                                                                                                                                  
+                
                                                                                                                                                                                  
+                  
+                    Field type: 
+                  
+                  string option
+                
                                                                                                                                                                                  
+                
                                                                                                                                                                                  
+              
                                                                                                                                                                                  
+            
                                                                                                                                                                                  
+          
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+  
                                                                                                                                                                                  
+
                                                                                                                                                                                  
+        
+    
                                                                                                                                                                                  
+
                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                  
+        
                                                                                                                                                                                    
+        
                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-literatesource.html b/reference/fsharp-formatting-literate-literatesource.html
new file mode 100644
index 000000000..f4f6c8537
--- /dev/null
+++ b/reference/fsharp-formatting-literate-literatesource.html
@@ -0,0 +1,508 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    LiterateSource (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                    
+
                                                                                                                                                                                    
+
+
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+        
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+    LiterateSource Type
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      Base Type: 
+      obj
+    
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      All Interfaces: 
+      IEquatable<LiterateSource>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<LiterateSource>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      
                                                                                                                                                                                    
+        
                                                                                                                                                                                    
+           Represents the source of a literate document.
+        
                                                                                                                                                                                    
+      
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+    
                                                                                                                                                                                    
+      Union cases
+    
                                                                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                    
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                    
+                  
+                    
+                      Markdown string
+                    
+                  
+                
                                                                                                                                                                                    
+                                                                                                                                                                                                  
+              
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                  Full Usage: 
+                  Markdown string
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                  Parameters: 
+                  
                                                                                                                                                                                      
+                    
+                      
+                        Item
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                      
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+              
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+                                                                                                                                                                                              		
+            
                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                    
                                                                                                                                                                                    
+                       A markdown source
+                    
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                    
+                      
+                    
+                  
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                                                                                                                                                                                                  
+              
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                  
+                    Item
+                  
+                  :
+                  string
+                
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+              
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+          
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                    
+                  
+                    
+                      Script Snippet array
+                    
+                  
+                
                                                                                                                                                                                    
+                                                                                                                                                                                                  
+              
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                  Full Usage: 
+                  Script Snippet array
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                  Parameters: 
+                  
                                                                                                                                                                                      
+                    
+                      
+                        Item
+                      
+                      :
+                      Snippet array
+                    
+                    
                                                                                                                                                                                      
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+              
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+                                                                                                                                                                                              		
+            
                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                    
                                                                                                                                                                                    
+                       A parsed F# script file consisting of snippets.
+                    
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                  
                                                                                                                                                                                    
+                    
+                      
+                    
+                  
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                                                                                                                                                                                                  
+              
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+                  
+                    Item
+                  
+                  :
+                  Snippet array
+                
                                                                                                                                                                                    
+                
                                                                                                                                                                                    
+              
                                                                                                                                                                                    
+            
                                                                                                                                                                                    
+          
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+  
                                                                                                                                                                                    
+
                                                                                                                                                                                    
+        
+    
                                                                                                                                                                                    
+
                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                    
+        
                                                                                                                                                                                      
+        
                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-markdownpatterns.html b/reference/fsharp-formatting-literate-markdownpatterns.html
new file mode 100644
index 000000000..5e8df5d5e
--- /dev/null
+++ b/reference/fsharp-formatting-literate-markdownpatterns.html
@@ -0,0 +1,437 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownPatterns (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                      
+
                                                                                                                                                                                      
+
+
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+        
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+    MarkdownPatterns Module
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+      
                                                                                                                                                                                      
+        
                                                                                                                                                                                      
+          
+ Provides active patterns for extracting LiterateParagraph values from
+ Markdown documents.
+ 
+        
                                                                                                                                                                                      
+      
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+    
                                                                                                                                                                                      
+      Active patterns
+    
                                                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                      
+            Active pattern
+          
+            Description
+            
+          
                                                                                                                                                                                      
+            
                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                      
+                  
+                    
+                      (|LiterateParagraph|_|) _arg1
+                    
+                  
+                
                                                                                                                                                                                      
+                                                                                                                                                                                                    
+              
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+                  Full Usage: 
+                  (|LiterateParagraph|_|) _arg1
+                  
                                                                                                                                                                                      
+                  
                                                                                                                                                                                      
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                      
+                  
+                    Returns: 
+                    LiterateParagraph option
+                  
+                  
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+            
                                                                                                                                                                                      
+                                                                                                                                                                                                		
+            
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+                  
+                    _arg1
+                  
+                  :
+                  MarkdownParagraph
+                
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  LiterateParagraph option
+                
                                                                                                                                                                                      
+                
                                                                                                                                                                                      
+              
                                                                                                                                                                                      
+            
                                                                                                                                                                                      
+          
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+  
                                                                                                                                                                                      
+
                                                                                                                                                                                      
+        
+    
                                                                                                                                                                                      
+
                                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                                      
+        
                                                                                                                                                                                        
+        
                                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+                                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate-outputkind.html b/reference/fsharp-formatting-literate-outputkind.html
new file mode 100644
index 000000000..94d5b9d1d
--- /dev/null
+++ b/reference/fsharp-formatting-literate-outputkind.html
@@ -0,0 +1,635 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    OutputKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                        
+
                                                                                                                                                                                        
+
+
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+        
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+    OutputKind Type
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.Literate
+      
+    
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Assembly: FSharp.Formatting.Literate.dll
+    
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Base Type: 
+      ValueType
+    
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      All Interfaces: 
+      IEquatable<OutputKind>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<OutputKind>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Kind: Struct
+    
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      
                                                                                                                                                                                        
+        
                                                                                                                                                                                        
+           Defines the possible output types from literate script (HTML, Latex, Pynb)
+        
                                                                                                                                                                                        
+      
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Union cases
+    
                                                                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                        
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      Fsx
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  Fsx
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                   Requests F# Script output
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      Html
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  Html
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                   Requests HTML output
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      Latex
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  Latex
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                   Requests LaTeX output
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      Markdown
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  Markdown
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                   Requests Markdown output
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      Pynb
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  Pynb
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                   Requests Notebook output
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+    
                                                                                                                                                                                        
+      Instance members
+    
                                                                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                        
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                        
+                  
+                    
+                      this.Extension
+                    
+                  
+                
                                                                                                                                                                                        
+                                                                                                                                                                                                      
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  Full Usage: 
+                  this.Extension
+                  
                                                                                                                                                                                        
+                  
                                                                                                                                                                                        
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+                                                                                                                                                                                                  		
+            
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                        
+                
                                                                                                                                                                                        
+              
                                                                                                                                                                                        
+            
                                                                                                                                                                                        
+          
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+  
                                                                                                                                                                                        
+
                                                                                                                                                                                        
+        
+    
                                                                                                                                                                                        
+
                                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                                        
+        
                                                                                                                                                                                          
+        
                                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                                          
+    
                                                                                                                                                                                          
+                                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-literate.html b/reference/fsharp-formatting-literate.html
new file mode 100644
index 000000000..cec835883
--- /dev/null
+++ b/reference/fsharp-formatting-literate.html
@@ -0,0 +1,664 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.Literate | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                          
+    
                                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                          
+    
                                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                          
+
                                                                                                                                                                                          
+
+
                                                                                                                                                                                          
+    
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+  
                                                                                                                                                                                          
+    FSharp.Formatting.Literate Namespace
+  
                                                                                                                                                                                          
+  
                                                                                                                                                                                          
+    
                                                                                                                                                                                          
+      Functionality to support literate programming for F# scripts
+    
                                                                                                                                                                                          
+  
                                                                                                                                                                                          
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                                                          
+          Type/Module
+        
+          Description
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                IndexText
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                Literate
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+ This type provides three simple methods for calling the literate programming tool.
+ The ConvertMarkdownFile and ConvertScriptFile methods process a single Markdown document
+ and F# script, respectively. The ConvertDirectory method handles an entire directory tree
+ (looking for *.fsx and *.md files).
+ 
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateCodeOptions
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+ Additional properties of a literate code snippet, embedded in a
+ LiterateParagraph.LiterateCode. The properties specify how should
+ a snippet be evaluated and formatted.
+ 
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateCodeVisibility
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                 Specifies visibility of a code snippet.
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateDocument
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                 Representation of a literate document - the representation of Paragraphs
+ uses an F# discriminated union type and so is best used from F#.
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateParagraph
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+ Extends MarkdownParagrap using the MarkdownEmbedParagraphs case with
+ additional kinds of paragraphs that can appear in literate F# scripts
+ (such as various special commands to embed output of a snippet etc.)
+ 
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateParagraphOptions
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                 Specifies the options for a literate paragraph
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                LiterateSource
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                 Represents the source of a literate document.
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                MarkdownPatterns
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+ Provides active patterns for extracting LiterateParagraph values from
+ Markdown documents.
+ 
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+              
+                OutputKind
+              
+            
+          
                                                                                                                                                                                          
+                                                                                                                                                                                                  		
+          
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                 Defines the possible output types from literate script (HTML, Latex, Pynb)
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+              
+                
+              
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+              
                                                                                                                                                                                          
+                
+              
                                                                                                                                                                                          
+            
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+
                                                                                                                                                                                          
+        
+    
                                                                                                                                                                                          
+
                                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                                          
+        
                                                                                                                                                                                            
+        
                                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+                                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-dsl.html b/reference/fsharp-formatting-markdown-dsl.html
new file mode 100644
index 000000000..8ac235f41
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-dsl.html
@@ -0,0 +1,1382 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Dsl (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                            
+
                                                                                                                                                                                            
+
+
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+        
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+    Dsl Module
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+      
                                                                                                                                                                                            
+        
                                                                                                                                                                                            
+          
+        
                                                                                                                                                                                            
+      
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+    
                                                                                                                                                                                            
+      Functions and values
+    
                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                            
+            Function or value
+          
+            Description
+            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      !!value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  !!value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                              
+                    
+                      
+                        value
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                              
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  string
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ``#####`` value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ``#####`` value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ``####`` value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ``####`` value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ``###`` value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ``###`` value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ``##`` value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ``##`` value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ``#`` value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ``#`` value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      img body link
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  img body link
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                              
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                              
+                    
+                      
+                        link
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                              
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    link
+                  
+                  :
+                  string
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      link content url
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  link content url
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                              
+                    
+                      
+                        content
+                      
+                      :
+                      MarkdownSpans
+                    
+                    
                                                                                                                                                                                              
+                    
+                      
+                        url
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                              
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    content
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    url
+                  
+                  :
+                  string
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ol value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ol value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      p value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  p value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      span value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  span value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      strong value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  strong value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      table headers alignments rows
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  table headers alignments rows
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    headers
+                  
+                  :
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    alignments
+                  
+                  :
+                  MarkdownColumnAlignment list
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    rows
+                  
+                  :
+                  MarkdownTableRow list
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                            
+                  
+                    
+                      ul value
+                    
+                  
+                
                                                                                                                                                                                            
+                                                                                                                                                                                                          
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  Full Usage: 
+                  ul value
+                  
                                                                                                                                                                                            
+                  
                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+                                                                                                                                                                                                      		
+            
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    value
+                  
+                  :
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                            
+                
                                                                                                                                                                                            
+              
                                                                                                                                                                                            
+            
                                                                                                                                                                                            
+          
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+  
                                                                                                                                                                                            
+
                                                                                                                                                                                            
+        
+    
                                                                                                                                                                                            
+
                                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                                            
+        
                                                                                                                                                                                              
+        
                                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+                                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-htmlformatting.html b/reference/fsharp-formatting-markdown-htmlformatting.html
new file mode 100644
index 000000000..8f6c2b219
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-htmlformatting.html
@@ -0,0 +1,565 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    HtmlFormatting (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                              
+
                                                                                                                                                                                              
+
+
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+        
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+    HtmlFormatting Module
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+      
                                                                                                                                                                                              
+        
                                                                                                                                                                                              
+          
+        
                                                                                                                                                                                              
+      
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+    
                                                                                                                                                                                              
+      Functions and values
+    
                                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                              
+            Function or value
+          
+            Description
+            
+          
                                                                                                                                                                                              
+            
                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                              
+                  
+                    
+                      formatAsHtml writer generateAnchors wrap links substitutions newline crefResolver mdlinkResolver paragraphs
+                    
+                  
+                
                                                                                                                                                                                              
+                                                                                                                                                                                                            
+              
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  Full Usage: 
+                  formatAsHtml writer generateAnchors wrap links substitutions newline crefResolver mdlinkResolver paragraphs
+                  
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                  Parameters: 
+                  
                                                                                                                                                                                                
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        generateAnchors
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        wrap
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        links
+                      
+                      :
+                      IDictionary<string, (string * string option)>
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        substitutions
+                      
+                      :
+                      Substitutions
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                
+                    
+                      
+                        paragraphs
+                      
+                      :
+                      MarkdownParagraphs
+                    
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+              
                                                                                                                                                                                              
+            
                                                                                                                                                                                              
+                                                                                                                                                                                                        		
+            
                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                    
                                                                                                                                                                                              
+                       Format Markdown document and write the result to
+ a specified TextWriter. Parameters specify newline character
+ and a dictionary with link keys defined in the document.
+                    
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                              
+                    
                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                              
+                  
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                                                                                                                                                                                                            
+              
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    generateAnchors
+                  
+                  :
+                  bool
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    wrap
+                  
+                  :
+                  bool
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    links
+                  
+                  :
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    substitutions
+                  
+                  :
+                  Substitutions
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+                  
+                    paragraphs
+                  
+                  :
+                  MarkdownParagraphs
+                
                                                                                                                                                                                              
+                
                                                                                                                                                                                              
+              
                                                                                                                                                                                              
+            
                                                                                                                                                                                              
+          
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+  
                                                                                                                                                                                              
+
                                                                                                                                                                                              
+        
+    
                                                                                                                                                                                              
+
                                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                                              
+        
                                                                                                                                                                                                
+        
                                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+                                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdown.html b/reference/fsharp-formatting-markdown-markdown.html
new file mode 100644
index 000000000..8e88f4903
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdown.html
@@ -0,0 +1,2167 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Markdown (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                
+
                                                                                                                                                                                                
+
+
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+        
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+    Markdown Type
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+      
                                                                                                                                                                                                
+        
                                                                                                                                                                                                
+           Static class that provides methods for formatting
+ and transforming Markdown documents.
+        
                                                                                                                                                                                                
+      
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+    
                                                                                                                                                                                                
+      Static members
+    
                                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.Parse(text, ?newline, ?parseOptions)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.Parse(text, ?newline, ?parseOptions)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        text
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?parseOptions
+                      
+                      :
+                      MarkdownParseOptions
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    MarkdownDocument
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Parse the specified text into a MarkdownDocument. Line breaks in the
+ inline HTML (etc.) will be stored using the specified string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    text
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?parseOptions
+                  
+                  :
+                  MarkdownParseOptions
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToFsx(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToFsx(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into Fsx and return the result as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToHtml(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToHtml(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        markdownText
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform Markdown document into HTML format.
+ The result will be returned as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    markdownText
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToHtml(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToHtml(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into HTML
+ format and return the result as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToLatex(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToLatex(markdownText, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        markdownText
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform Markdown text into LaTeX format. The result will be returned as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    markdownText
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToLatex(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToLatex(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into LaTeX
+ format and return the result as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToMd(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToMd(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into Markdown and return the result as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.ToPynb(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.ToPynb(doc, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
+                    Returns: 
+                    string
+                  
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into Pynb and return the result as a string.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.WriteHtml(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.WriteHtml(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        markdownText
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform Markdown text into HTML format. The result
+ will be written to the provided TextWriter.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    markdownText
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.WriteHtml(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.WriteHtml(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into HTML
+ format and write the result to a given writer.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.WriteLatex(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.WriteLatex(markdownText, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        markdownText
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform Markdown document into LaTeX format. The result
+ will be written to the provided TextWriter.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    markdownText
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
+                    
+                      Markdown.WriteLatex(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                    
+                  
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  Full Usage: 
+                  Markdown.WriteLatex(doc, writer, ?newline, ?substitutions, ?crefResolver, ?mdlinkResolver, ?lineNumbers)
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                  
+                    
+                      
+                        doc
+                      
+                      :
+                      MarkdownDocument
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        writer
+                      
+                      :
+                      TextWriter
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?newline
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?substitutions
+                      
+                      :
+                      (ParamKey * string) list
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?crefResolver
+                      
+                      :
+                      string -> (string * string) option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?mdlinkResolver
+                      
+                      :
+                      string -> string option
+                    
+                    
                                                                                                                                                                                                  
+                    
+                      
+                        ?lineNumbers
+                      
+                      :
+                      bool
+                    
+                    
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                       Transform the provided MarkdownDocument into LaTeX
+ format and write the result to a given writer.
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                    
+                      
+                    
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                    
                                                                                                                                                                                                
+                      
+                    
                                                                                                                                                                                                
+                  
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                                                                                                                                                                                                              
+              
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    doc
+                  
+                  :
+                  MarkdownDocument
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    writer
+                  
+                  :
+                  TextWriter
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?newline
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?substitutions
+                  
+                  :
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?crefResolver
+                  
+                  :
+                  string -> (string * string) option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?mdlinkResolver
+                  
+                  :
+                  string -> string option
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+                  
+                    ?lineNumbers
+                  
+                  :
+                  bool
+                
                                                                                                                                                                                                
+                
                                                                                                                                                                                                
+              
                                                                                                                                                                                                
+            
                                                                                                                                                                                                
+          
                                                                                                                                                                                                
+  
                                                                                                                                                                                                
+
                                                                                                                                                                                                
+        
+    
                                                                                                                                                                                                
+
                                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                                
+        
                                                                                                                                                                                                  
+        
                                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdowncolumnalignment.html b/reference/fsharp-formatting-markdown-markdowncolumnalignment.html
new file mode 100644
index 000000000..547d42cfb
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdowncolumnalignment.html
@@ -0,0 +1,533 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownColumnAlignment (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+        
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+    MarkdownColumnAlignment Type
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      Base Type: 
+      ValueType
+    
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      All Interfaces: 
+      IEquatable<MarkdownColumnAlignment>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<MarkdownColumnAlignment>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      Kind: Struct
+    
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      
                                                                                                                                                                                                  
+        
                                                                                                                                                                                                  
+           Column in a table can be aligned to left, right, center or using the default alignment
+        
                                                                                                                                                                                                  
+      
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+    
                                                                                                                                                                                                  
+      Union cases
+    
                                                                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                  
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                  
+                  
+                    
+                      AlignCenter
+                    
+                  
+                
                                                                                                                                                                                                  
+                                                                                                                                                                                                                
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  Full Usage: 
+                  AlignCenter
+                  
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+          
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                  
+                  
+                    
+                      AlignDefault
+                    
+                  
+                
                                                                                                                                                                                                  
+                                                                                                                                                                                                                
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  Full Usage: 
+                  AlignDefault
+                  
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+          
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                  
+                  
+                    
+                      AlignLeft
+                    
+                  
+                
                                                                                                                                                                                                  
+                                                                                                                                                                                                                
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  Full Usage: 
+                  AlignLeft
+                  
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+          
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                  
+                  
+                    
+                      AlignRight
+                    
+                  
+                
                                                                                                                                                                                                  
+                                                                                                                                                                                                                
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  Full Usage: 
+                  AlignRight
+                  
                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
                                                                                                                                                                                                  
+                  
+                
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+              
                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                  
+            
                                                                                                                                                                                                  
+          
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+  
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  
+        
+    
                                                                                                                                                                                                  
+
                                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                                  
+        
                                                                                                                                                                                                    
+        
                                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+                                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdowndocument.html b/reference/fsharp-formatting-markdown-markdowndocument.html
new file mode 100644
index 000000000..b66db1699
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdowndocument.html
@@ -0,0 +1,598 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownDocument (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                    
+
                                                                                                                                                                                                    
+
+
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+        
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+    MarkdownDocument Type
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      
                                                                                                                                                                                                    
+        
                                                                                                                                                                                                    
+          
+ Representation of a Markdown document - the representation of Paragraphs
+ uses an F# discriminated union type and so is best used from F#.
+ 
+        
                                                                                                                                                                                                    
+      
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      Constructors
+    
                                                                                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                    
+            Constructor
+          
+            Description
+            
+          
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                    
+                  
+                    
+                      MarkdownDocument(paragraphs, links)
+                    
+                  
+                
                                                                                                                                                                                                    
+                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  Full Usage: 
+                  MarkdownDocument(paragraphs, links)
+                  
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownDocument
+                  
+                  
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  
+                    paragraphs
+                  
+                  :
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  
+                    links
+                  
+                  :
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownDocument
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+          
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+    
                                                                                                                                                                                                    
+      Instance members
+    
                                                                                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                    
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                    
+                  
+                    
+                      this.DefinedLinks
+                    
+                  
+                
                                                                                                                                                                                                    
+                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.DefinedLinks
+                  
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    IDictionary<string, (string * string option)>
+                  
+                  
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                    
                                                                                                                                                                                                    
+                       Returns a dictionary containing explicitly defined links
+                    
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                    
+                      
+                    
+                    
                                                                                                                                                                                                    
+                      
+                    
                                                                                                                                                                                                    
+                    
                                                                                                                                                                                                    
+                      
+                    
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  IDictionary<string, (string * string option)>
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+          
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                    
+                  
+                    
+                      this.Paragraphs
+                    
+                  
+                
                                                                                                                                                                                                    
+                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.Paragraphs
+                  
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                    
                                                                                                                                                                                                    
+                       Returns a list of paragraphs in the document
+                    
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                    
+                      
+                    
+                    
                                                                                                                                                                                                    
+                      
+                    
                                                                                                                                                                                                    
+                    
                                                                                                                                                                                                    
+                      
+                    
                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                    
+                
                                                                                                                                                                                                    
+              
                                                                                                                                                                                                    
+            
                                                                                                                                                                                                    
+          
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+  
                                                                                                                                                                                                    
+
                                                                                                                                                                                                    
+        
+    
                                                                                                                                                                                                    
+
                                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                                    
+        
                                                                                                                                                                                                      
+        
                                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+                                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownembedparagraphs.html b/reference/fsharp-formatting-markdown-markdownembedparagraphs.html
new file mode 100644
index 000000000..eb7fdab02
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownembedparagraphs.html
@@ -0,0 +1,424 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownEmbedParagraphs (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      
+
+
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+        
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+    MarkdownEmbedParagraphs Type
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      All Interfaces: 
+      MarkdownEmbedParagraphs
+    
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      
                                                                                                                                                                                                      
+        
                                                                                                                                                                                                      
+           Provides an extensibility point for adding custom kinds of paragraphs into a document
+ (MarkdownEmbedParagraphs values can be embedded using MarkdownParagraph.EmbedParagraphs)
+        
                                                                                                                                                                                                      
+      
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+    
                                                                                                                                                                                                      
+      Instance members
+    
                                                                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                      
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                      
+            
                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                      
+                  
+                    
+                      this.Render
+                    
+                  
+                
                                                                                                                                                                                                      
+                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                      
+                
                                                                                                                                                                                                      
+                  Full Usage: 
+                  this.Render
+                  
                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                                                      
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                                                                      
+                
                                                                                                                                                                                                      
+              
                                                                                                                                                                                                      
+            
                                                                                                                                                                                                      
+                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                      
+              
                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                      
+              
                                                                                                                                                                                                      
+                
                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                      
+                
                                                                                                                                                                                                      
+              
                                                                                                                                                                                                      
+            
                                                                                                                                                                                                      
+          
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+  
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      
+        
+    
                                                                                                                                                                                                      
+
                                                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                                                      
+        
                                                                                                                                                                                                        
+        
                                                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+                                                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownembedspans.html b/reference/fsharp-formatting-markdown-markdownembedspans.html
new file mode 100644
index 000000000..f588fe4ad
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownembedspans.html
@@ -0,0 +1,424 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownEmbedSpans (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        
+
+
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+        
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+    MarkdownEmbedSpans Type
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      All Interfaces: 
+      MarkdownEmbedSpans
+    
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      
                                                                                                                                                                                                        
+        
                                                                                                                                                                                                        
+           Provides an extensibility point for adding custom kinds of spans into a document
+ (MarkdownEmbedSpans values can be embedded using MarkdownSpan.EmbedSpans)
+        
                                                                                                                                                                                                        
+      
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+    
                                                                                                                                                                                                        
+      Instance members
+    
                                                                                                                                                                                                        
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                        
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                        
+            
                                                                                                                                                                                                        
+              
+                
                                                                                                                                                                                                        
+                  
+                    
+                      this.Render
+                    
+                  
+                
                                                                                                                                                                                                        
+                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                        
+                
                                                                                                                                                                                                        
+                  Full Usage: 
+                  this.Render
+                  
                                                                                                                                                                                                        
+                  
                                                                                                                                                                                                        
+                  
+                    Returns: 
+                    MarkdownSpans
+                  
+                  
                                                                                                                                                                                                        
+                  Modifiers: 
+                  abstract
+                  
                                                                                                                                                                                                        
+                
                                                                                                                                                                                                        
+              
                                                                                                                                                                                                        
+            
                                                                                                                                                                                                        
+                                                                                                                                                                                                                  		
+            
                                                                                                                                                                                                        
+              
                                                                                                                                                                                                        
+                
+                  
+                
+              
                                                                                                                                                                                                        
+              
                                                                                                                                                                                                        
+                
                                                                                                                                                                                                        
+                  
+                    Returns: 
+                  
+                  MarkdownSpans
+                
                                                                                                                                                                                                        
+                
                                                                                                                                                                                                        
+              
                                                                                                                                                                                                        
+            
                                                                                                                                                                                                        
+          
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+  
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        
+        
+    
                                                                                                                                                                                                        
+
                                                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                                                        
+        
                                                                                                                                                                                                          
+        
                                                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+                                                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownlistkind.html b/reference/fsharp-formatting-markdown-markdownlistkind.html
new file mode 100644
index 000000000..87a94af45
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownlistkind.html
@@ -0,0 +1,461 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownListKind (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          
+
+
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+        
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+    MarkdownListKind Type
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      Base Type: 
+      ValueType
+    
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      All Interfaces: 
+      IEquatable<MarkdownListKind>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<MarkdownListKind>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      Kind: Struct
+    
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      
                                                                                                                                                                                                          
+        
                                                                                                                                                                                                          
+          
+   A list kind can be Ordered or Unordered corresponding to <ol> and <ul> elements
+ 
+        
                                                                                                                                                                                                          
+      
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+    
                                                                                                                                                                                                          
+      Union cases
+    
                                                                                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                          
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                          
+                  
+                    
+                      Ordered
+                    
+                  
+                
                                                                                                                                                                                                          
+                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+                  Full Usage: 
+                  Ordered
+                  
                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+                  
+                
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+          
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                          
+                  
+                    
+                      Unordered
+                    
+                  
+                
                                                                                                                                                                                                          
+                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+                  Full Usage: 
+                  Unordered
+                  
                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+                
                                                                                                                                                                                                          
+                  
+                
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+              
                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                          
+            
                                                                                                                                                                                                          
+          
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+  
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          
+        
+    
                                                                                                                                                                                                          
+
                                                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                                                          
+        
                                                                                                                                                                                                            
+        
                                                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownparagraph.html b/reference/fsharp-formatting-markdown-markdownparagraph.html
new file mode 100644
index 000000000..686a7b520
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownparagraph.html
@@ -0,0 +1,1642 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownParagraph (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+        
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+    MarkdownParagraph Type
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      All Interfaces: 
+      IEquatable<MarkdownParagraph>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      
                                                                                                                                                                                                            
+        
                                                                                                                                                                                                            
+           A paragraph represents a (possibly) multi-line element of a Markdown document.
+ Paragraphs are headings, inline paragraphs, code blocks, lists, quotations, tables and
+ also embedded LaTeX blocks.
+        
                                                                                                                                                                                                            
+      
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+    
                                                                                                                                                                                                            
+      Union cases
+    
                                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                            
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      CodeBlock(code, executionCount, fence, language, ignoredLine, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  CodeBlock(code, executionCount, fence, language, ignoredLine, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        executionCount
+                      
+                      :
+                      int option
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        fence
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        language
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        ignoredLine
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A code block, whether fenced or via indentation
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    executionCount
+                  
+                  :
+                  int option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    fence
+                  
+                  :
+                  string option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    language
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    ignoredLine
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      EmbedParagraphs(customParagraphs, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  EmbedParagraphs(customParagraphs, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A special addition for computing paragraphs
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    customParagraphs
+                  
+                  :
+                  MarkdownEmbedParagraphs
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      Heading(size, body, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  Heading(size, body, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    size
+                  
+                  :
+                  int
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      HorizontalRule(character, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  HorizontalRule(character, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        character
+                      
+                      :
+                      char
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown Horizontal rule
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    character
+                  
+                  :
+                  char
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      InlineHtmlBlock(code, executionCount, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  InlineHtmlBlock(code, executionCount, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        executionCount
+                      
+                      :
+                      int option
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A HTML block
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    executionCount
+                  
+                  :
+                  int option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      LatexBlock(env, body, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  LatexBlock(env, body, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        env
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        body
+                      
+                      :
+                      string list
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown Latex block
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    env
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    body
+                  
+                  :
+                  string list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      ListBlock(kind, items, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  ListBlock(kind, items, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown List block
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    kind
+                  
+                  :
+                  MarkdownListKind
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    items
+                  
+                  :
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      OtherBlock(lines, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  OtherBlock(lines, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       Represents a block of markdown produced when parsing of code or tables or quoted blocks is suppressed
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    lines
+                  
+                  :
+                  (string * MarkdownRange) list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      OutputBlock(output, kind, executionCount)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  OutputBlock(output, kind, executionCount)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        output
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        kind
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        executionCount
+                      
+                      :
+                      int option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A special addition for inserted outputs
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    output
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    kind
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    executionCount
+                  
+                  :
+                  int option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      Paragraph(body, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  Paragraph(body, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      QuotedBlock(paragraphs, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  QuotedBlock(paragraphs, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown Quote block
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    paragraphs
+                  
+                  :
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      Span(body, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  Span(body, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown Span block
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      TableBlock(headers, alignments, rows, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  TableBlock(headers, alignments, rows, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A Markdown Table
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    headers
+                  
+                  :
+                  MarkdownTableRow option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    alignments
+                  
+                  :
+                  MarkdownColumnAlignment list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    rows
+                  
+                  :
+                  MarkdownTableRow list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
+                    
+                      YamlFrontmatter(yaml, range)
+                    
+                  
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  Full Usage: 
+                  YamlFrontmatter(yaml, range)
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                              
+                    
+                      
+                        yaml
+                      
+                      :
+                      string list
+                    
+                    
                                                                                                                                                                                                              
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
                                                                                                                                                                                                            
+                       A special addition for YAML-style frontmatter
+                    
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                            
+                    
+                      
+                    
+                  
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    yaml
+                  
+                  :
+                  string list
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                            
+                
                                                                                                                                                                                                            
+              
                                                                                                                                                                                                            
+            
                                                                                                                                                                                                            
+          
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+  
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            
+        
+    
                                                                                                                                                                                                            
+
                                                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                                                            
+        
                                                                                                                                                                                                              
+        
                                                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+                                                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownparagraphs.html b/reference/fsharp-formatting-markdown-markdownparagraphs.html
new file mode 100644
index 000000000..1d822be7f
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownparagraphs.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownParagraphs (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                              
+
                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+        
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+    MarkdownParagraphs Type
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Abbreviation For: 
+      MarkdownParagraph list
+    
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<MarkdownParagraph>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<MarkdownParagraph>
+      , 
+      IReadOnlyCollection<MarkdownParagraph>
+      , 
+      IEnumerable<MarkdownParagraph>
+      , 
+      IEnumerable
+    
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      
                                                                                                                                                                                                              
+        
                                                                                                                                                                                                              
+           A type alias for a list of paragraphs
+        
                                                                                                                                                                                                              
+      
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Instance members
+    
                                                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                              
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  Parameters: 
+                  
                                                                                                                                                                                                                
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownParagraph list
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph list
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+    
                                                                                                                                                                                                              
+      Static members
+    
                                                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                              
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                              
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                                                                                                                              
+                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    MarkdownParagraph list
+                  
+                  
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph list
+                
                                                                                                                                                                                                              
+                
                                                                                                                                                                                                              
+              
                                                                                                                                                                                                              
+            
                                                                                                                                                                                                              
+          
                                                                                                                                                                                                              
+  
                                                                                                                                                                                                              
+
                                                                                                                                                                                                              
+        
+    
                                                                                                                                                                                                              
+
                                                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+                                                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownparseoptions.html b/reference/fsharp-formatting-markdown-markdownparseoptions.html
new file mode 100644
index 000000000..ef3c21f7b
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownparseoptions.html
@@ -0,0 +1,582 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownParseOptions (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                
+
                                                                                                                                                                                                                
+
+
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+    MarkdownParseOptions Type
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      Base Type: 
+      Enum
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      All Interfaces: 
+      IComparable
+      , 
+      IConvertible
+      , 
+      ISpanFormattable
+      , 
+      IFormattable
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      Kind: Struct
+    
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      This is an enum type definition
+    
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                
+           Controls the parsing of markdown
+        
                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                
+      Record fields
+    
                                                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                
+                  
+                    
+                      AllowYamlFrontMatter
+                    
+                  
+                
                                                                                                                                                                                                                
+                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  Full Usage: 
+                  AllowYamlFrontMatter
+                  
                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                    MarkdownParseOptions
+                  
+                  
                                                                                                                                                                                                                
+                  Modifiers: 
+                  static
+                  
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                  
+                  MarkdownParseOptions
+                
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                
+                  
+                    
+                      None
+                    
+                  
+                
                                                                                                                                                                                                                
+                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  Full Usage: 
+                  None
+                  
                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                    MarkdownParseOptions
+                  
+                  
                                                                                                                                                                                                                
+                  Modifiers: 
+                  static
+                  
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                  
+                  MarkdownParseOptions
+                
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                
+                  
+                    
+                      ParseCodeAsOther
+                    
+                  
+                
                                                                                                                                                                                                                
+                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  Full Usage: 
+                  ParseCodeAsOther
+                  
                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                    MarkdownParseOptions
+                  
+                  
                                                                                                                                                                                                                
+                  Modifiers: 
+                  static
+                  
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                  
+                  MarkdownParseOptions
+                
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                
+                  
+                    
+                      ParseNonCodeAsOther
+                    
+                  
+                
                                                                                                                                                                                                                
+                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  Full Usage: 
+                  ParseNonCodeAsOther
+                  
                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                    MarkdownParseOptions
+                  
+                  
                                                                                                                                                                                                                
+                  Modifiers: 
+                  static
+                  
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+                  
+                    Field type: 
+                  
+                  MarkdownParseOptions
+                
                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                
+
                                                                                                                                                                                                                
+        
+    
                                                                                                                                                                                                                
+
                                                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+                                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns-paragraphleafinfo.html b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphleafinfo.html
new file mode 100644
index 000000000..290790ff8
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphleafinfo.html
@@ -0,0 +1,354 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ParagraphLeafInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                  
+    ParagraphLeafInfo Type
+  
                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      Parent Module: 
+      
+        MarkdownPatterns
+      
+    
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      All Interfaces: 
+      IEquatable<ParagraphLeafInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+      
                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                  
+          
+        
                                                                                                                                                                                                                  
+      
                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                  
+        
+    
                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+                                                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns-paragraphnestedinfo.html b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphnestedinfo.html
new file mode 100644
index 000000000..ff1ba8154
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphnestedinfo.html
@@ -0,0 +1,354 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ParagraphNestedInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                    
+
+
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                    
+    ParagraphNestedInfo Type
+  
                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      Parent Module: 
+      
+        MarkdownPatterns
+      
+    
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      All Interfaces: 
+      IEquatable<ParagraphNestedInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+      
                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                    
+          
+        
                                                                                                                                                                                                                    
+      
                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                    
+        
+    
                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+                                                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns-paragraphspansinfo.html b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphspansinfo.html
new file mode 100644
index 000000000..b9e540597
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns-paragraphspansinfo.html
@@ -0,0 +1,354 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ParagraphSpansInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                      
+
+
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                      
+    ParagraphSpansInfo Type
+  
                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      Parent Module: 
+      
+        MarkdownPatterns
+      
+    
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      All Interfaces: 
+      IEquatable<ParagraphSpansInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                      
+          
+        
                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                      
+        
+    
                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+                                                                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns-spanleafinfo.html b/reference/fsharp-formatting-markdown-markdownpatterns-spanleafinfo.html
new file mode 100644
index 000000000..0f57f0998
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns-spanleafinfo.html
@@ -0,0 +1,354 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    SpanLeafInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                        
+
+
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                        
+    SpanLeafInfo Type
+  
                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      Parent Module: 
+      
+        MarkdownPatterns
+      
+    
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      All Interfaces: 
+      IEquatable<SpanLeafInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+      
                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                        
+          
+        
                                                                                                                                                                                                                        
+      
                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                        
+        
+    
                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+                                                                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns-spannodeinfo.html b/reference/fsharp-formatting-markdown-markdownpatterns-spannodeinfo.html
new file mode 100644
index 000000000..e09ba1fa3
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns-spannodeinfo.html
@@ -0,0 +1,354 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    SpanNodeInfo (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                          
+
+
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                          
+    SpanNodeInfo Type
+  
                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      Parent Module: 
+      
+        MarkdownPatterns
+      
+    
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      All Interfaces: 
+      IEquatable<SpanNodeInfo>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+      
                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                          
+          
+        
                                                                                                                                                                                                                          
+      
                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                          
+        
+    
                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownpatterns.html b/reference/fsharp-formatting-markdown-markdownpatterns.html
new file mode 100644
index 000000000..83e121154
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownpatterns.html
@@ -0,0 +1,1084 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownPatterns (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    MarkdownPatterns Module
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      
                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                            
+           This module provides an easy way of processing Markdown documents.
+ It lets you decompose documents into leafs and nodes with nested paragraphs.
+        
                                                                                                                                                                                                                            
+      
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      Types
+    
                                                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                            
+            Type
+          
+            Description
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
+                  ParagraphLeafInfo
+                
+              
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
+                  ParagraphNestedInfo
+                
+              
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
+                  ParagraphSpansInfo
+                
+              
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
+                  SpanLeafInfo
+                
+              
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
+                  SpanNodeInfo
+                
+              
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      Functions and values
+    
                                                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                            
+            Function or value
+          
+            Description
+            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      ParagraphLeaf arg1
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  ParagraphLeaf arg1
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    arg0
+                  
+                  :
+                  ParagraphLeafInfo
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      ParagraphNested (arg1, pars)
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  ParagraphNested (arg1, pars)
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    arg0
+                  
+                  :
+                  ParagraphNestedInfo
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    pars
+                  
+                  :
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      ParagraphSpans (arg1, spans)
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  ParagraphSpans (arg1, spans)
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownParagraph
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    arg0
+                  
+                  :
+                  ParagraphSpansInfo
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    spans
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownParagraph
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      SpanLeaf arg1
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  SpanLeaf arg1
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    arg0
+                  
+                  :
+                  SpanLeafInfo
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      SpanNode (arg1, spans)
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  SpanNode (arg1, spans)
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    arg0
+                  
+                  :
+                  SpanNodeInfo
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    spans
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                            
+      Active patterns
+    
                                                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                            
+            Active pattern
+          
+            Description
+            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      (|ParagraphLeaf|ParagraphNested|ParagraphSpans|) par
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  (|ParagraphLeaf|ParagraphNested|ParagraphSpans|) par
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    Choice<ParagraphLeafInfo, (ParagraphNestedInfo * MarkdownParagraphs list), (ParagraphSpansInfo * MarkdownSpans)>
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    par
+                  
+                  :
+                  MarkdownParagraph
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  Choice<ParagraphLeafInfo, (ParagraphNestedInfo * MarkdownParagraphs list), (ParagraphSpansInfo * MarkdownSpans)>
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                            
+                  
+                    
+                      (|SpanLeaf|SpanNode|) span
+                    
+                  
+                
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  Full Usage: 
+                  (|SpanLeaf|SpanNode|) span
+                  
                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                            
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                    Choice<SpanLeafInfo, (SpanNodeInfo * MarkdownSpans)>
+                  
+                  
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    span
+                  
+                  :
+                  MarkdownSpan
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+                  
+                    Returns: 
+                  
+                  Choice<SpanLeafInfo, (SpanNodeInfo * MarkdownSpans)>
+                
                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                            
+        
+    
                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownrange.html b/reference/fsharp-formatting-markdown-markdownrange.html
new file mode 100644
index 000000000..4e08f1055
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownrange.html
@@ -0,0 +1,569 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownRange (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+    MarkdownRange Type
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      Base Type: 
+      ValueType
+    
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      All Interfaces: 
+      IEquatable<MarkdownRange>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<MarkdownRange>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      Kind: Struct
+    
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      
                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                              
+          
+        
                                                                                                                                                                                                                              
+      
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                              
+      Record fields
+    
                                                                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                              
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                              
+                  
+                    
+                      EndColumn
+                    
+                  
+                
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  Full Usage: 
+                  EndColumn
+                  
                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                              
+                  
+                    
+                      EndLine
+                    
+                  
+                
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  Full Usage: 
+                  EndLine
+                  
                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                              
+                  
+                    
+                      StartColumn
+                    
+                  
+                
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  Full Usage: 
+                  StartColumn
+                  
                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                              
+                  
+                    
+                      StartLine
+                    
+                  
+                
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  Full Usage: 
+                  StartLine
+                  
                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
+                  
+                
+              
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                              
+        
+    
                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownrangemodule.html b/reference/fsharp-formatting-markdown-markdownrangemodule.html
new file mode 100644
index 000000000..6e63bd3c0
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownrangemodule.html
@@ -0,0 +1,480 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownRange (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                
+
+
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+    MarkdownRange Module
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                
+          
+        
                                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                
+      Functions and values
+    
                                                                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                
+            Function or value
+          
+            Description
+            
+          
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                
+                  
+                    
+                      mergeRanges ranges
+                    
+                  
+                
                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+                  Full Usage: 
+                  mergeRanges ranges
+                  
                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    MarkdownRange
+                  
+                  
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+                  
+                    ranges
+                  
+                  :
+                  MarkdownRange list
+                
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  MarkdownRange
+                
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                
+                  
+                    
+                      zero 
+                    
+                  
+                
                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+                  Full Usage: 
+                  zero 
+                  
                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    MarkdownRange
+                  
+                  
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  MarkdownRange
+                
                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                
+        
+    
                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownspan.html b/reference/fsharp-formatting-markdown-markdownspan.html
new file mode 100644
index 000000000..9812c1c35
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownspan.html
@@ -0,0 +1,1399 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownSpan (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+    MarkdownSpan Type
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      All Interfaces: 
+      IEquatable<MarkdownSpan>
+      , 
+      IStructuralEquatable
+    
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      
                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                  
+           Represents inline formatting inside a paragraph. This can be literal (with text), various
+ formattings (string, emphasis, etc.), hyperlinks, images, inline maths etc.
+        
                                                                                                                                                                                                                                  
+      
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                  
+      Union cases
+    
                                                                                                                                                                                                                                  
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                  
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      AnchorLink(link, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  AnchorLink(link, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        link
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    link
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      DirectImage(body, link, title, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  DirectImage(body, link, title, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        link
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        title
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    link
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    title
+                  
+                  :
+                  string option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      DirectLink(body, link, title, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  DirectLink(body, link, title, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        body
+                      
+                      :
+                      MarkdownSpans
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        link
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        title
+                      
+                      :
+                      string option
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    link
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    title
+                  
+                  :
+                  string option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      EmbedSpans(customSpans, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  EmbedSpans(customSpans, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    customSpans
+                  
+                  :
+                  MarkdownEmbedSpans
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      Emphasis(body, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  Emphasis(body, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      HardLineBreak range
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  HardLineBreak range
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      IndirectImage(body, link, key, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  IndirectImage(body, link, key, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        body
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        link
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        key
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    link
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    key
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      IndirectLink(body, original, key, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  IndirectLink(body, original, key, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        body
+                      
+                      :
+                      MarkdownSpans
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        original
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        key
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    original
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    key
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      InlineCode(code, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  InlineCode(code, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      LatexDisplayMath(code, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  LatexDisplayMath(code, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      LatexInlineMath(code, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  LatexInlineMath(code, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        code
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    code
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      Literal(text, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  Literal(text, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
                                                                                                                                                                                                                                    
+                    
+                      
+                        text
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                    
+                    
+                      
+                        range
+                      
+                      :
+                      MarkdownRange option
+                    
+                    
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    text
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+              
+                
                                                                                                                                                                                                                                  
+                  
+                    
+                      Strong(body, range)
+                    
+                  
+                
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  Full Usage: 
+                  Strong(body, range)
+                  
                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                  
+                  Parameters: 
+                  
+                  
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                            		
+            
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
+                  
+                
+              
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    body
+                  
+                  :
+                  MarkdownSpans
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+                  
+                    range
+                  
+                  :
+                  MarkdownRange option
+                
                                                                                                                                                                                                                                  
+                
                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                  
+        
+    
                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdownspans.html b/reference/fsharp-formatting-markdown-markdownspans.html
new file mode 100644
index 000000000..5ec9966fd
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdownspans.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownSpans (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                    
+
+
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+    MarkdownSpans Type
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Abbreviation For: 
+      MarkdownSpan list
+    
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<MarkdownSpan>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<MarkdownSpan>
+      , 
+      IReadOnlyCollection<MarkdownSpan>
+      , 
+      IEnumerable<MarkdownSpan>
+      , 
+      IEnumerable
+    
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      
                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                    
+           A type alias for a list of MarkdownSpan values
+        
                                                                                                                                                                                                                                    
+      
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Instance members
+    
                                                                                                                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                    
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  Parameters: 
+                  
                                                                                                                                                                                                                                      
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownSpan
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownSpan
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownSpan list
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownSpan list
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                    
+      Static members
+    
                                                                                                                                                                                                                                    
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                    
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+              
+                
                                                                                                                                                                                                                                    
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                    MarkdownSpan list
+                  
+                  
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                              		
+            
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
+                  
+                
+              
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+                  
+                    Returns: 
+                  
+                  MarkdownSpan list
+                
                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                    
+          
                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                    
+        
+    
                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown-markdowntablerow.html b/reference/fsharp-formatting-markdown-markdowntablerow.html
new file mode 100644
index 000000000..90897ec61
--- /dev/null
+++ b/reference/fsharp-formatting-markdown-markdowntablerow.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    MarkdownTableRow (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                      
+
+
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+    MarkdownTableRow Type
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Namespace: 
+      
+        FSharp.Formatting.Markdown
+      
+    
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Assembly: FSharp.Formatting.Markdown.dll
+    
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Abbreviation For: 
+      MarkdownParagraphs list
+    
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<MarkdownParagraphs>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<MarkdownParagraphs>
+      , 
+      IReadOnlyCollection<MarkdownParagraphs>
+      , 
+      IEnumerable<MarkdownParagraphs>
+      , 
+      IEnumerable
+    
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                      
+           A type alias representing table row as a list of paragraphs
+        
                                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Instance members
+    
                                                                                                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                      
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  Parameters: 
+                  
                                                                                                                                                                                                                                        
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                                                                                                                                                        
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    MarkdownParagraphs
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    MarkdownParagraphs list
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                      
+      Static members
+    
                                                                                                                                                                                                                                      
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                      
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+              
+                
                                                                                                                                                                                                                                      
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                    
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                                                                                                                                                      
+                  
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                    MarkdownParagraphs list
+                  
+                  
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                		
+            
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
+                  
+                
+              
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+                  
+                    Returns: 
+                  
+                  MarkdownParagraphs list
+                
                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                      
+  
                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                      
+        
+    
                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-markdown.html b/reference/fsharp-formatting-markdown.html
new file mode 100644
index 000000000..fbb791ff9
--- /dev/null
+++ b/reference/fsharp-formatting-markdown.html
@@ -0,0 +1,876 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.Markdown | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                        
+
+
                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                                        
+    FSharp.Formatting.Markdown Namespace
+  
                                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                        
+      Functionality for processing markdown documents, converting to HTML, LaTeX, ipynb and scripts
+    
                                                                                                                                                                                                                                        
+  
                                                                                                                                                                                                                                        
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                                                                                                        
+          Type/Module
+        
+          Description
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                Dsl
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                HtmlFormatting
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                Markdown
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Static class that provides methods for formatting
+ and transforming Markdown documents.
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownColumnAlignment
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Column in a table can be aligned to left, right, center or using the default alignment
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownDocument
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+ Representation of a Markdown document - the representation of Paragraphs
+ uses an F# discriminated union type and so is best used from F#.
+ 
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownEmbedParagraphs
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Provides an extensibility point for adding custom kinds of paragraphs into a document
+ (MarkdownEmbedParagraphs values can be embedded using MarkdownParagraph.EmbedParagraphs)
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownEmbedSpans
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Provides an extensibility point for adding custom kinds of spans into a document
+ (MarkdownEmbedSpans values can be embedded using MarkdownSpan.EmbedSpans)
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownListKind
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+   A list kind can be Ordered or Unordered corresponding to <ol> and <ul> elements
+ 
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownParagraph
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 A paragraph represents a (possibly) multi-line element of a Markdown document.
+ Paragraphs are headings, inline paragraphs, code blocks, lists, quotations, tables and
+ also embedded LaTeX blocks.
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownParagraphs
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 A type alias for a list of paragraphs
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownParseOptions
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Controls the parsing of markdown
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownPatterns
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 This module provides an easy way of processing Markdown documents.
+ It lets you decompose documents into leafs and nodes with nested paragraphs.
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownRange (Module)
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownRange (Type)
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownSpan
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 Represents inline formatting inside a paragraph. This can be literal (with text), various
+ formattings (string, emphasis, etc.), hyperlinks, images, inline maths etc.
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownSpans
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 A type alias for a list of MarkdownSpan values
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+            
+              
+                MarkdownTableRow
+              
+            
+          
                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                		
+          
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                 A type alias representing table row as a list of paragraphs
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+              
+                
+              
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                        
+                
+              
                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                        
+        
+    
                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-templating-frontmatterfile.html b/reference/fsharp-formatting-templating-frontmatterfile.html
new file mode 100644
index 000000000..ef7887547
--- /dev/null
+++ b/reference/fsharp-formatting-templating-frontmatterfile.html
@@ -0,0 +1,685 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FrontMatterFile (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                          
+
+
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+    FrontMatterFile Type
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      Namespace: 
+      
+        FSharp.Formatting.Templating
+      
+    
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      All Interfaces: 
+      IEquatable<FrontMatterFile>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<FrontMatterFile>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      
                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                          
+           Meta data from files that contains front matter
+ Used to determine upfront which files have front matter so that previous and next substitutes can be discovered.
+        
                                                                                                                                                                                                                                          
+      
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      Record fields
+    
                                                                                                                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                          
+            Record Field
+          
+            Description
+            
+          
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
+                    
+                      Category
+                    
+                  
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  Full Usage: 
+                  Category
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+          
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
+                    
+                      CategoryIndex
+                    
+                  
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  Full Usage: 
+                  CategoryIndex
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+          
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
+                    
+                      FileName
+                    
+                  
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  Full Usage: 
+                  FileName
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                    string
+                  
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  string
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+          
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
+                    
+                      Index
+                    
+                  
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  Full Usage: 
+                  Index
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                    int
+                  
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
+                  
+                
+              
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    Field type: 
+                  
+                  int
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+          
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                          
+      Static members
+    
                                                                                                                                                                                                                                          
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                          
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
+                    
+                      FrontMatterFile.ParseFromLines(fileName) (lines)
+                    
+                  
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  Full Usage: 
+                  FrontMatterFile.ParseFromLines(fileName) (lines)
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  Parameters: 
+                  
                                                                                                                                                                                                                                            
+                    
+                      
+                        fileName
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                            
+                    
+                      
+                        lines
+                      
+                      :
+                      string seq
+                    
+                    
                                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
+                    Returns: 
+                    FrontMatterFile option
+                  
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                    		
+            
                                                                                                                                                                                                                                          
+              
+                
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                    
                                                                                                                                                                                                                                          
+                       Parses the category, categoryindex and index from the frontmatter lines
+                    
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                          
+                      
+                    
                                                                                                                                                                                                                                          
+                    
                                                                                                                                                                                                                                          
+                      
+                    
                                                                                                                                                                                                                                          
+                  
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    fileName
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    lines
+                  
+                  :
+                  string seq
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+                  
+                    Returns: 
+                  
+                  FrontMatterFile option
+                
                                                                                                                                                                                                                                          
+                
                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                          
+            
                                                                                                                                                                                                                                          
+          
                                                                                                                                                                                                                                          
+  
                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                          
+        
+    
                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-templating-paramkey.html b/reference/fsharp-formatting-templating-paramkey.html
new file mode 100644
index 000000000..831952d78
--- /dev/null
+++ b/reference/fsharp-formatting-templating-paramkey.html
@@ -0,0 +1,441 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ParamKey (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+    ParamKey Type
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      Namespace: 
+      
+        FSharp.Formatting.Templating
+      
+    
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      Base Type: 
+      ValueType
+    
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      All Interfaces: 
+      IEquatable<ParamKey>
+      , 
+      IStructuralEquatable
+      , 
+      IComparable<ParamKey>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+    
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      Kind: Struct
+    
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      
                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                            
+          
+ A parameter key
+ 
+        
                                                                                                                                                                                                                                            
+      
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                            
+      Union cases
+    
                                                                                                                                                                                                                                            
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                            
+            Union case
+          
+            Description
+            
+          
                                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                                            
+              
+                
                                                                                                                                                                                                                                            
+                  
+                    
+                      ParamKey string
+                    
+                  
+                
                                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                                          
+              
                                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                                            
+                  Full Usage: 
+                  ParamKey string
+                  
                                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                                            
+                  Parameters: 
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                        Item
+                      
+                      :
+                      string
+                    
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                            
+                  
                                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                                      		
+            
                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                            
+                
+                  
+                
+              
                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                                            
+                  
+                    Item
+                  
+                  :
+                  string
+                
                                                                                                                                                                                                                                            
+                
                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+  
                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                            
+        
+    
                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-templating-paramkeys.html b/reference/fsharp-formatting-templating-paramkeys.html
new file mode 100644
index 000000000..716e5444e
--- /dev/null
+++ b/reference/fsharp-formatting-templating-paramkeys.html
@@ -0,0 +1,3056 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    ParamKeys (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+    ParamKeys Module
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+      Namespace: 
+      
+        FSharp.Formatting.Templating
+      
+    
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+      
                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                              
+            Defines the parameter keys known to FSharp.Formatting processing code
+        
                                                                                                                                                                                                                                              
+      
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                              
+      Functions and values
+    
                                                                                                                                                                                                                                              
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                              
+            Function or value
+          
+            Description
+            
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-authors`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-authors`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-body-class`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-body-class`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, either 'content' or 'api-doc'
+ Mean to be used on the `class` attribute in the `` tag.
+ This helps to differentiate styles between API docs and custom content.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-body-extra`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-body-extra`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available when `_head.html` exists in the input folder.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-collection-name-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-collection-name-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-collection-name`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-collection-name`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-content`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-content`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-copyright`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-copyright`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-favicon-src`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-favicon-src`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-head-extra`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-head-extra`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available when `_head.html` exists in the input folder.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-license-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-license-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-list-of-documents`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-list-of-documents`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-list-of-namespaces`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-list-of-namespaces`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-logo-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-logo-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-logo-src`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-logo-src`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-header-active-class`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-header-active-class`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu_template.html
+ This will be an empty string if the category is not active.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-header-content`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-header-content`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-header-id`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-header-id`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-item-active-class`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-item-active-class`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu-item_template.html
+ /// This will be an empty string if the item is not active.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-item-content`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-item-content`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu-item_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-item-id`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-item-id`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu-item_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-item-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-item-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu-item_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-menu-items`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-menu-items`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available in _menu_template.html
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-meta-tags`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-meta-tags`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, it is HTML composed from additional frontmatter information.
+ Such as tags and description
+ This can be empty when both properties are not provided for the current page.
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-next-page-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-next-page-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available when frontmatter is used correctly
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-package-icon-url`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-package-icon-url`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-package-license-expression`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-package-license-expression`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-package-project-url`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-package-project-url`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-package-tags`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-package-tags`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-package-version`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-package-version`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-page-content-list`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-page-content-list`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-page-source`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-page-source`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-page-title`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-page-title`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-previous-page-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-previous-page-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting, available when frontmatter is used correctly
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-release-notes-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-release-notes-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-repository-branch`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-repository-branch`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-repository-commit`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-repository-commit`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-repository-link`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-repository-link`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-source-basename`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-source-basename`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-source-filename`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-source-filename`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-source`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-source`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-theme`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-theme`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-tooltips`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-tooltips`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.``fsdocs-watch-script`` 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.``fsdocs-watch-script`` 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
+                    
+                      ParamKeys.root 
+                    
+                  
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  Full Usage: 
+                  ParamKeys.root 
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                    ParamKey
+                  
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                        		
+            
                                                                                                                                                                                                                                              
+              
+                
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                       A parameter key known to FSharp.Formatting
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                    
+                      
+                    
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                    
                                                                                                                                                                                                                                              
+                      
+                    
                                                                                                                                                                                                                                              
+                  
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                            
+              
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+                  
+                    Returns: 
+                  
+                  ParamKey
+                
                                                                                                                                                                                                                                              
+                
                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                              
+          
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+  
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+        
+    
                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-templating-substitutions.html b/reference/fsharp-formatting-templating-substitutions.html
new file mode 100644
index 000000000..648a10dae
--- /dev/null
+++ b/reference/fsharp-formatting-templating-substitutions.html
@@ -0,0 +1,709 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Substitutions (FSharp.Formatting) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                
+
+
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+    Substitutions Type
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Namespace: 
+      
+        FSharp.Formatting.Templating
+      
+    
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Assembly: FSharp.Formatting.Common.dll
+    
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Abbreviation For: 
+      (ParamKey * string) list
+    
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Base Type: 
+      obj
+    
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      All Interfaces: 
+      IStructuralEquatable
+      , 
+      IComparable<List<ParamKey * string>>
+      , 
+      IComparable
+      , 
+      IStructuralComparable
+      , 
+      IReadOnlyList<ParamKey * string>
+      , 
+      IReadOnlyCollection<ParamKey * string>
+      , 
+      IEnumerable<ParamKey * string>
+      , 
+      IEnumerable
+    
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                
+           A list of parameters for substituting in templates, indexed by parameter keys
+        
                                                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Instance members
+    
                                                                                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                                
+            Instance member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      this.Head
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  this.Head
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    ParamKey * string
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  ParamKey * string
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      this.IsEmpty
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  this.IsEmpty
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    bool
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  bool
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      this[index]
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  this[index]
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  Parameters: 
+                  
                                                                                                                                                                                                                                                  
+                    
+                      
+                        index
+                      
+                      :
+                      int
+                    
+                    
                                                                                                                                                                                                                                                  
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    ParamKey * string
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    index
+                  
+                  :
+                  int
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  ParamKey * string
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      this.Length
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  this.Length
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    int
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  int
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      this.Tail
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  this.Tail
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    (ParamKey * string) list
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                
+      Static members
+    
                                                                                                                                                                                                                                                
+    
+      
+        
+          
+          
+        
+      
+      
+        
+          
+          
+        
+      
+    
                                                                                                                                                                                                                                                
+            Static member
+          
+            Description
+            
+          
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+              
+                
                                                                                                                                                                                                                                                
+                  
+                    
+                      List.Empty
+                    
+                  
+                
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                              
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  Full Usage: 
+                  List.Empty
+                  
                                                                                                                                                                                                                                                
+                  
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                    (ParamKey * string) list
+                  
+                  
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                          		
+            
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
+                  
+                
+              
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+                  
+                    Returns: 
+                  
+                  (ParamKey * string) list
+                
                                                                                                                                                                                                                                                
+                
                                                                                                                                                                                                                                                
+              
                                                                                                                                                                                                                                                
+            
                                                                                                                                                                                                                                                
+          
                                                                                                                                                                                                                                                
+  
                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                
+        
+    
                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/fsharp-formatting-templating.html b/reference/fsharp-formatting-templating.html
new file mode 100644
index 000000000..6d0dc7bf7
--- /dev/null
+++ b/reference/fsharp-formatting-templating.html
@@ -0,0 +1,464 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting.Templating | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                                  
+    FSharp.Formatting.Templating Namespace
+  
                                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                  
+      Functionality relating to templating (mostly internal)
+    
                                                                                                                                                                                                                                                  
+  
                                                                                                                                                                                                                                                  
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                                                                                                                  
+          Type/Module
+        
+          Description
+        
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+            
+              
+                FrontMatterFile
+              
+            
+          
                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                          		
+          
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                 Meta data from files that contains front matter
+ Used to determine upfront which files have front matter so that previous and next substitutes can be discovered.
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
+                
+              
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+            
+              
+                ParamKey
+              
+            
+          
                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                          		
+          
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                
+ A parameter key
+ 
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
+                
+              
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+            
+              
+                ParamKeys
+              
+            
+          
                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                          		
+          
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                  Defines the parameter keys known to FSharp.Formatting processing code
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
+                
+              
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+            
+              
+                Substitutions
+              
+            
+          
                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                          		
+          
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                 A list of parameters for substituting in templates, indexed by parameter keys
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+              
+                
+              
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+              
                                                                                                                                                                                                                                                  
+                
+              
                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  
+        
+    
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/reference/index.html b/reference/index.html
new file mode 100644
index 000000000..6eb6f599a
--- /dev/null
+++ b/reference/index.html
@@ -0,0 +1,413 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    FSharp.Formatting (API Reference) | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                    
+
+
                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                                    
+    API Reference
+  
                                                                                                                                                                                                                                                    
+  
                                                                                                                                                                                                                                                    
+    Available Namespaces:
+  
                                                                                                                                                                                                                                                    
+  
+    
+      
+        
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
+  
                                                                                                                                                                                                                                                    
+          Namespace
+        
+          Description
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.ApiDocs
+          
+        
+          Functionality relating to generating API documentation
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.CSharpFormat
+          
+        
+          Functionality for formatting code in various languages
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.CodeFormat
+          
+        
+          Functionality relating to formatting F# scripts and code snippets
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.Common
+          
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.Literate
+          
+        
+          Functionality to support literate programming for F# scripts
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.Literate.Evaluation
+          
+        
+          Functionality to support literate evaluation for F# scripts
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.Markdown
+          
+        
+          Functionality for processing markdown documents, converting to HTML, LaTeX, ipynb and scripts
+        
                                                                                                                                                                                                                                                    
+          
+            FSharp.Formatting.Templating
+          
+        
+          Functionality relating to templating (mostly internal)
+        
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                    
+        
+    
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sidebyside/sideextensions.fsx b/sidebyside/sideextensions.fsx
new file mode 100644
index 000000000..e194b7a0c
--- /dev/null
+++ b/sidebyside/sideextensions.fsx
@@ -0,0 +1,43 @@
+(**
+# Example: Using the Markdown Extensions for LaTeX
+
+
+
+To use LaTex extension, you need to add javascript
+link to [MathJax](http://www.mathjax.org/) in
+your template or inside a `_head.html` file.
+
+```html
+
+```
+
+To use inline LaTex, eclose LaTex code with `$`:
+$k_{n+1} = n^2 + k_n^2 - k_{n-1}$. Alternatively,
+you can also use `$$`.
+
+To use block LaTex, start a new paragraph, with
+the first line marked as `$$$` (no close `$$$`):
+
+\begin{equation}
+A_{m,n} =
+ \begin{pmatrix}
+  a_{1,1} & a_{1,2} & \cdots & a_{1,n} \\
+  a_{2,1} & a_{2,2} & \cdots & a_{2,n} \\
+  \vdots  & \vdots  & \ddots & \vdots  \\
+  a_{m,1} & a_{m,2} & \cdots & a_{m,n}
+ \end{pmatrix}
+\end{equation}
+
+Use LaTex escape rule:
+
+* Escape $ in inline mode: $\$$, $\$var$
+
+* Other escapes: $\& \% \$ \# \_ \{ \}$
+
+* Using < or >: $x > 1$, $y < 1$, $x >= 1$,
+$y <= 1$, $x = 1$
+
+* $
                                                                                                                                                                                                                                                      something
                                                                                                                                                                                                                                                      $
+
+*)
+
diff --git a/sidebyside/sideextensions.html b/sidebyside/sideextensions.html
new file mode 100644
index 000000000..ee2fd4e09
--- /dev/null
+++ b/sidebyside/sideextensions.html
@@ -0,0 +1,350 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Markdown LaTeX | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                      
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                      
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      
+
+
                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                      
+        
+
                                                                                                                                                                                                                                                      Example: Using the Markdown Extensions for LaTeX
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      To use LaTex extension, you need to add javascript
+link to MathJax in
+your template or inside a _head.html file.
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
+
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      To use inline LaTex, eclose LaTex code with $:
+\(k_{n+1} = n^2 + k_n^2 - k_{n-1}\). Alternatively,
+you can also use $$.
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      To use block LaTex, start a new paragraph, with
+the first line marked as $$$ (no close $$$):
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      \[A_{m,n} =
+ \begin{pmatrix}
+  a_{1,1} & a_{1,2} & \cdots & a_{1,n} \\
+  a_{2,1} & a_{2,2} & \cdots & a_{2,n} \\
+  \vdots  & \vdots  & \ddots & \vdots  \\
+  a_{m,1} & a_{m,2} & \cdots & a_{m,n}
+ \end{pmatrix}\]
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      Use LaTex escape rule:
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                      • Escape $ in inline mode: \(\$\), \(\$var\)
                                                                                                                                                                                                                                                        • 
+
                                                                                                                                                                                                                                                      • Other escapes: \(\& \% \$ \# \_ \{ \}\)
                                                                                                                                                                                                                                                        • 
+
                                                                                                                                                                                                                                                      • 
+Using < or >: \(x > 1\), \(y < 1\), \(x >= 1\),
+\(y <= 1\), \(x = 1\)
+
                                                                                                                                                                                                                                                        • 
+
                                                                                                                                                                                                                                                      • \(<p>something</p>\)
                                                                                                                                                                                                                                                        • 
+
                                                                                                                                                                                                                                                      
+
+        
+    
                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                      
+
+
+    
+    
                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                        Type something to start searching.
                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                        
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sidebyside/sideextensions.ipynb b/sidebyside/sideextensions.ipynb
new file mode 100644
index 000000000..804b2db0f
--- /dev/null
+++ b/sidebyside/sideextensions.ipynb
@@ -0,0 +1,80 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Example: Using the Markdown Extensions for LaTeX\n",
+    "\n",
+    "\u003cscript id=\"MathJax-script\" async src=\"https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js\"\u003e\u003c/script\u003e\n",
+    "\n",
+    "To use LaTex extension, you need to add javascript\n",
+    "link to [MathJax](http://www.mathjax.org/) in\n",
+    "your template or inside a `_head.html` file.\n",
+    "\n",
+    "```html\n",
+    "\u003cscript id=\"MathJax-script\" async src=\"https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js\"\u003e\u003c/script\u003e\n",
+    "```\n",
+    "\n",
+    "To use inline LaTex, eclose LaTex code with `$`:\n",
+    "$k_{n+1} = n^2 + k_n^2 - k_{n-1}$. Alternatively,\n",
+    "you can also use `$$`.\n",
+    "\n",
+    "To use block LaTex, start a new paragraph, with\n",
+    "the first line marked as `$$$` (no close `$$$`):\n",
+    "\n",
+    "\\begin{equation}\n",
+    "A_{m,n} =\n",
+    " \\begin{pmatrix}\n",
+    "  a_{1,1} \u0026 a_{1,2} \u0026 \\cdots \u0026 a_{1,n} \\\\\n",
+    "  a_{2,1} \u0026 a_{2,2} \u0026 \\cdots \u0026 a_{2,n} \\\\\n",
+    "  \\vdots  \u0026 \\vdots  \u0026 \\ddots \u0026 \\vdots  \\\\\n",
+    "  a_{m,1} \u0026 a_{m,2} \u0026 \\cdots \u0026 a_{m,n}\n",
+    " \\end{pmatrix}\n",
+    "\\end{equation}\n",
+    "\n",
+    "Use LaTex escape rule:\n",
+    "\n",
+    "* Escape $ in inline mode: $\\$$, $\\$var$\n",
+    "\n",
+    "* Other escapes: $\\\u0026 \\% \\$ \\# \\_ \\{ \\}$\n",
+    "\n",
+    "* Using \u003c or \u003e: $x \u003e 1$, $y \u003c 1$, $x \u003e= 1$,\n",
+    "$y \u003c= 1$, $x = 1$\n",
+    "\n",
+    "* $\u003cp\u003esomething\u003c/p\u003e$\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/sidebyside/sideextensions.md b/sidebyside/sideextensions.md
new file mode 100644
index 000000000..d7ffbc5b1
--- /dev/null
+++ b/sidebyside/sideextensions.md
@@ -0,0 +1,41 @@
+# Example: Using the Markdown Extensions for LaTeX
+
+
+
+To use LaTex extension, you need to add javascript
+link to [MathJax](http://www.mathjax.org/) in
+your template or inside a `_head.html` file.
+
+```html
+
+```
+
+To use inline LaTex, eclose LaTex code with `$`:
+$k_{n+1} = n^2 + k_n^2 - k_{n-1}$. Alternatively,
+you can also use `$$`.
+
+To use block LaTex, start a new paragraph, with
+the first line marked as `$$$` (no close `$$$`):
+
+\begin{equation}
+A_{m,n} =
+ \begin{pmatrix}
+  a_{1,1} & a_{1,2} & \cdots & a_{1,n} \\
+  a_{2,1} & a_{2,2} & \cdots & a_{2,n} \\
+  \vdots  & \vdots  & \ddots & \vdots  \\
+  a_{m,1} & a_{m,2} & \cdots & a_{m,n}
+ \end{pmatrix}
+\end{equation}
+
+Use LaTex escape rule:
+
+* Escape $ in inline mode: $\$$, $\$var$
+
+* Other escapes: $\& \% \$ \# \_ \{ \}$
+
+* Using < or >: $x > 1$, $y < 1$, $x >= 1$,
+$y <= 1$, $x = 1$
+
+* $
                                                                                                                                                                                                                                                        something
                                                                                                                                                                                                                                                        $
+
+
diff --git a/sidebyside/sideextensions.tex b/sidebyside/sideextensions.tex
new file mode 100644
index 000000000..15decbd0d
--- /dev/null
+++ b/sidebyside/sideextensions.tex
@@ -0,0 +1,100 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Example: Using the Markdown Extensions for LaTeX}
+
+
+
+
+
+
+To use LaTex extension, you need to add javascript
+link to \href{http://www.mathjax.org/}{MathJax} in
+your template or inside a \texttt{\_head.html} file.
+\begin{lstlisting}
+
+
+\end{lstlisting}
+
+
+To use inline LaTex, eclose LaTex code with \texttt{\$}:
+$k_{n+1} = n^2 + k_n^2 - k_{n-1}$. Alternatively,
+you can also use \texttt{\$\$}.
+
+
+To use block LaTex, start a new paragraph, with
+the first line marked as \texttt{\$\$\$} (no close \texttt{\$\$\$}):
+
+
+\begin{equation}
+A_{m,n} =
+ \begin{pmatrix}
+  a_{1,1} & a_{1,2} & \cdots & a_{1,n} \\
+  a_{2,1} & a_{2,2} & \cdots & a_{2,n} \\
+  \vdots  & \vdots  & \ddots & \vdots  \\
+  a_{m,1} & a_{m,2} & \cdots & a_{m,n}
+ \end{pmatrix}
+\end{equation}
+
+
+
+
+Use LaTex escape rule:
+\begin{itemize}
+\item Escape \$ in inline mode: $\$$, $\$var$
+
+\item Other escapes: $\& \% \$ \# \_ \{ \}$
+
+\item Using < or >: $x > 1$, $y < 1$, $x >= 1$,
+$y <= 1$, $x = 1$
+
+\item $
                                                                                                                                                                                                                                                        something
                                                                                                                                                                                                                                                        $
+
+\end{itemize}
+
+
+
+\end{document}
\ No newline at end of file
diff --git a/sidebyside/sidemarkdown.fsx b/sidebyside/sidemarkdown.fsx
new file mode 100644
index 000000000..2c62e6f3c
--- /dev/null
+++ b/sidebyside/sidemarkdown.fsx
@@ -0,0 +1,66 @@
+(**
+# Example: Using Markdown Content
+
+This file demonstrates how to write Markdown document with
+embedded F# snippets that can be transformed into nice HTML
+using the `literate.fsx` script from the [F# Formatting
+package](http://fsprojects.github.io/FSharp.Formatting).
+
+In this case, the document itself is a valid Markdown and
+you can use standard Markdown features to format the text:
+
+* Here is an example of an unordered list and...
+
+* Text formatting including **bold** and **emphasis**
+
+For more information, see the [Markdown](http://daringfireball.net/projects/markdown) reference.
+
+## Writing F# code
+
+In standard Markdown, you can include code snippets by
+writing a block indented by four spaces and the code
+snippet will be turned into a `
                                                                                                                                                                                                                                                        ` element. If you do
+the same using the Literate F# tool, the code is turned into
+a nicely formatted F# snippet:
+
+    /// The Hello World of functional languages!
+    let rec factorial x = 
+      if x = 0 then 1 
+      else x * (factorial (x - 1))
+
+    let f10 = factorial 10
+
+
+## Hiding code
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the `hide`
+command. You can also use `module=...` to specify that
+the snippet should be placed in a separate module
+(e.g. to avoid duplicate definitions).
+
+    [hide, module=Hidden]
+    /// This is a hidden answer
+    let answer = 42
+
+The value will be defined in the F# code that is
+processed and so you can use it from other (visible)
+code and get correct tooltips:
+
+    let answer = Hidden.answer
+
+## Including other snippets
+
+When writing literate programs as Markdown documents,
+you can also include snippets in other languages.
+These will not be colorized and processed as F#
+code samples:
+
+    [lang=csharp]
+    Console.WriteLine("Hello world!");
+
+This snippet is turned into a `pre` element with the
+`lang` attribute set to `csharp`.
+
+*)
+
diff --git a/sidebyside/sidemarkdown.html b/sidebyside/sidemarkdown.html
new file mode 100644
index 000000000..c29861c53
--- /dev/null
+++ b/sidebyside/sidemarkdown.html
@@ -0,0 +1,389 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Markdown Content | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                        
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                        
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        
+
+
                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                        
+        
+
                                                                                                                                                                                                                                                        Example: Using Markdown Content
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        This file demonstrates how to write Markdown document with
+embedded F# snippets that can be transformed into nice HTML
+using the literate.fsx script from the F# Formatting
+package.
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        In this case, the document itself is a valid Markdown and
+you can use standard Markdown features to format the text:
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                        • Here is an example of an unordered list and...
                                                                                                                                                                                                                                                          • 
+
                                                                                                                                                                                                                                                        • Text formatting including bold and emphasis
                                                                                                                                                                                                                                                          • 
+
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        For more information, see the Markdown reference.
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        Writing F# code
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        In standard Markdown, you can include code snippets by
+writing a block indented by four spaces and the code
+snippet will be turned into a <pre> element. If you do
+the same using the Literate F# tool, the code is turned into
+a nicely formatted F# snippet:
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        /// The Hello World of functional languages!
+let rec factorial x = 
+  if x = 0 then 1 
+  else x * (factorial (x - 1))
+
+let f10 = factorial 10
+
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        Hiding code
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        If you want to include some code in the source code,
+but omit it from the output, you can use the hide
+command. You can also use module=... to specify that
+the snippet should be placed in a separate module
+(e.g. to avoid duplicate definitions).
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        The value will be defined in the F# code that is
+processed and so you can use it from other (visible)
+code and get correct tooltips:
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        let answer = Hidden.answer
+
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        Including other snippets
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        When writing literate programs as Markdown documents,
+you can also include snippets in other languages.
+These will not be colorized and processed as F#
+code samples:
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        Console.WriteLine("Hello world!");
+
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        This snippet is turned into a pre element with the
+lang attribute set to csharp.
                                                                                                                                                                                                                                                        
+
+        
                                                                                                                                                                                                                                                        val factorial: x: int -> int
                                                                                                                                                                                                                                                         The Hello World of functional languages!
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        val x: int
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        val f10: int
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        val answer: int
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        module Hidden
+
+from sidemarkdown
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        val answer: int
                                                                                                                                                                                                                                                         This is a hidden answer
                                                                                                                                                                                                                                                        
+
+    
                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                        
+
+
+    
+    
                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                                          Type something to start searching.
                                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                                          
+                                                                                                                                                                                                                                                          
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sidebyside/sidemarkdown.ipynb b/sidebyside/sidemarkdown.ipynb
new file mode 100644
index 000000000..d5310ed56
--- /dev/null
+++ b/sidebyside/sidemarkdown.ipynb
@@ -0,0 +1,103 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Example: Using Markdown Content\n",
+    "\n",
+    "This file demonstrates how to write Markdown document with\n",
+    "embedded F# snippets that can be transformed into nice HTML\n",
+    "using the `literate.fsx` script from the [F# Formatting\n",
+    "package](http://fsprojects.github.io/FSharp.Formatting).\n",
+    "\n",
+    "In this case, the document itself is a valid Markdown and\n",
+    "you can use standard Markdown features to format the text:\n",
+    "\n",
+    "* Here is an example of an unordered list and...\n",
+    "\n",
+    "* Text formatting including **bold** and **emphasis**\n",
+    "\n",
+    "For more information, see the [Markdown](http://daringfireball.net/projects/markdown) reference.\n",
+    "\n",
+    "## Writing F# code\n",
+    "\n",
+    "In standard Markdown, you can include code snippets by\n",
+    "writing a block indented by four spaces and the code\n",
+    "snippet will be turned into a `\u003cpre\u003e` element. If you do\n",
+    "the same using the Literate F# tool, the code is turned into\n",
+    "a nicely formatted F# snippet:\n",
+    "\n",
+    "    /// The Hello World of functional languages!\n",
+    "    let rec factorial x = \n",
+    "      if x = 0 then 1 \n",
+    "      else x * (factorial (x - 1))\n",
+    "\n",
+    "    let f10 = factorial 10\n",
+    "\n",
+    "\n",
+    "## Hiding code\n",
+    "\n",
+    "If you want to include some code in the source code,\n",
+    "but omit it from the output, you can use the `hide`\n",
+    "command. You can also use `module=...` to specify that\n",
+    "the snippet should be placed in a separate module\n",
+    "(e.g. to avoid duplicate definitions).\n",
+    "\n",
+    "    [hide, module=Hidden]\n",
+    "    /// This is a hidden answer\n",
+    "    let answer = 42\n",
+    "\n",
+    "The value will be defined in the F# code that is\n",
+    "processed and so you can use it from other (visible)\n",
+    "code and get correct tooltips:\n",
+    "\n",
+    "    let answer = Hidden.answer\n",
+    "\n",
+    "## Including other snippets\n",
+    "\n",
+    "When writing literate programs as Markdown documents,\n",
+    "you can also include snippets in other languages.\n",
+    "These will not be colorized and processed as F#\n",
+    "code samples:\n",
+    "\n",
+    "    [lang=csharp]\n",
+    "    Console.WriteLine(\"Hello world!\");\n",
+    "\n",
+    "This snippet is turned into a `pre` element with the\n",
+    "`lang` attribute set to `csharp`.\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/sidebyside/sidemarkdown.md b/sidebyside/sidemarkdown.md
new file mode 100644
index 000000000..2a0cc0bc6
--- /dev/null
+++ b/sidebyside/sidemarkdown.md
@@ -0,0 +1,64 @@
+# Example: Using Markdown Content
+
+This file demonstrates how to write Markdown document with
+embedded F# snippets that can be transformed into nice HTML
+using the `literate.fsx` script from the [F# Formatting
+package](http://fsprojects.github.io/FSharp.Formatting).
+
+In this case, the document itself is a valid Markdown and
+you can use standard Markdown features to format the text:
+
+* Here is an example of an unordered list and...
+
+* Text formatting including **bold** and **emphasis**
+
+For more information, see the [Markdown](http://daringfireball.net/projects/markdown) reference.
+
+## Writing F# code
+
+In standard Markdown, you can include code snippets by
+writing a block indented by four spaces and the code
+snippet will be turned into a `
                                                                                                                                                                                                                                                          ` element. If you do
+the same using the Literate F# tool, the code is turned into
+a nicely formatted F# snippet:
+
+    /// The Hello World of functional languages!
+    let rec factorial x = 
+      if x = 0 then 1 
+      else x * (factorial (x - 1))
+
+    let f10 = factorial 10
+
+
+## Hiding code
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the `hide`
+command. You can also use `module=...` to specify that
+the snippet should be placed in a separate module
+(e.g. to avoid duplicate definitions).
+
+    [hide, module=Hidden]
+    /// This is a hidden answer
+    let answer = 42
+
+The value will be defined in the F# code that is
+processed and so you can use it from other (visible)
+code and get correct tooltips:
+
+    let answer = Hidden.answer
+
+## Including other snippets
+
+When writing literate programs as Markdown documents,
+you can also include snippets in other languages.
+These will not be colorized and processed as F#
+code samples:
+
+    [lang=csharp]
+    Console.WriteLine("Hello world!");
+
+This snippet is turned into a `pre` element with the
+`lang` attribute set to `csharp`.
+
+
diff --git a/sidebyside/sidemarkdown.tex b/sidebyside/sidemarkdown.tex
new file mode 100644
index 000000000..fb74c525b
--- /dev/null
+++ b/sidebyside/sidemarkdown.tex
@@ -0,0 +1,131 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Example: Using Markdown Content}
+
+
+
+This file demonstrates how to write Markdown document with
+embedded F\# snippets that can be transformed into nice HTML
+using the \texttt{literate.fsx} script from the \href{http://fsprojects.github.io/FSharp.Formatting}{F\# Formatting
+package}.
+
+
+In this case, the document itself is a valid Markdown and
+you can use standard Markdown features to format the text:
+\begin{itemize}
+\item Here is an example of an unordered list and...
+
+\item Text formatting including \textbf{bold} and \emph{emphasis}
+
+\end{itemize}
+
+
+
+For more information, see the \href{http://daringfireball.net/projects/markdown}{Markdown} reference.
+\subsection*{Writing F\# code}
+
+
+
+In standard Markdown, you can include code snippets by
+writing a block indented by four spaces and the code
+snippet will be turned into a \texttt{
                                                                                                                                                                                                                                                          } element. If you do
+the same using the Literate F\# tool, the code is turned into
+a nicely formatted F\# snippet:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{/// The Hello World of functional languages!}
+\kwd{let} \kwd{rec} \lfun{factorial} \lfun{x} \ops{=} 
+  \kwd{if} \lfun{x} \ops{=} \num{0} \kwd{then} \num{1} 
+  \kwd{else} \lfun{x} \ops{*} {(}\lfun{factorial} {(}\lfun{x} \ops{-} \num{1}{)}{)}
+
+\kwd{let} \id{f10} \ops{=} \lfun{factorial} \num{10}
+
+
+\end{lstlisting}
+
+\subsection*{Hiding code}
+
+
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the \texttt{hide}
+command. You can also use \texttt{module=...} to specify that
+the snippet should be placed in a separate module
+(e.g. to avoid duplicate definitions).
+
+
+The value will be defined in the F\# code that is
+processed and so you can use it from other (visible)
+code and get correct tooltips:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{answer} \ops{=} \ltyp{Hidden}{.}\id{answer}
+
+
+\end{lstlisting}
+
+\subsection*{Including other snippets}
+
+
+
+When writing literate programs as Markdown documents,
+you can also include snippets in other languages.
+These will not be colorized and processed as F\#
+code samples:
+\begin{lstlisting}
+Console.WriteLine("Hello world!");
+
+\end{lstlisting}
+
+
+This snippet is turned into a \texttt{pre} element with the
+\texttt{lang} attribute set to \texttt{csharp}.
+
+
+\end{document}
\ No newline at end of file
diff --git a/sidebyside/sidescript.fsx b/sidebyside/sidescript.fsx
new file mode 100644
index 000000000..867272965
--- /dev/null
+++ b/sidebyside/sidescript.fsx
@@ -0,0 +1,68 @@
+(**
+# Example: Using Literate Script Content
+
+This file demonstrates how to write literate F# script
+files (`*.fsx`) that can be transformed into nice HTML
+using the `literate.fsx` script from the [F# Formatting
+package](http://fsprojects.github.io/FSharp.Formatting).
+
+As you can see, a comment starting with a double asterisk
+is treated as part of the document and is transformed
+using Markdown, which means that you can use:
+
+* Unordered or ordered lists
+
+* Text formatting including **bold** and **emphasis**
+
+And numerous other [Markdown](http://daringfireball.net/projects/markdown) features.
+
+## Writing F# code
+
+Code that is not inside the comment will be formatted as
+a sample snippet.
+
+*)
+/// The Hello World of functional languages!
+let rec factorial x =
+    if x = 0 then 1 else x * (factorial (x - 1))
+
+let f10 = factorial 10
+(**
+## Hiding code
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the `hide`
+command.
+
+The value will be defined in the F# code and so you
+can use it from other (visible) code and get the correct
+tooltips:
+
+*)
+let answer = hidden
+(**
+## Moving code around
+
+Sometimes, it is useful to first explain some code that
+has to be located at the end of the snippet (perhaps
+because it uses some definitions discussed in the middle).
+This can be done using `include` and `define` commands.
+
+The following snippet gets the correct tooltips, even though
+it uses `laterFunction`:
+
+*)
+let sample = laterFunction () |> printfn "Got: %s"
+(**
+Then, we can explain how `laterFunction` is defined:
+
+*)
+let laterFunction () = "Not very difficult, is it?"
+(**
+This example covers pretty much all features that are
+currently implemented in `literate.fsx`, but feel free
+to [fork the project on GitHub](https://github.com/fsprojects/FSharp.Formatting) and add more
+features or report bugs!
+
+*)
+
diff --git a/sidebyside/sidescript.html b/sidebyside/sidescript.html
new file mode 100644
index 000000000..2d434a569
--- /dev/null
+++ b/sidebyside/sidescript.html
@@ -0,0 +1,391 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Literate Script | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                                          
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                                          
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          
+
+
                                                                                                                                                                                                                                                          
+    
                                                                                                                                                                                                                                                          
+        
+
                                                                                                                                                                                                                                                          Example: Using Literate Script Content
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          This file demonstrates how to write literate F# script
+files (*.fsx) that can be transformed into nice HTML
+using the literate.fsx script from the F# Formatting
+package.
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          As you can see, a comment starting with a double asterisk
+is treated as part of the document and is transformed
+using Markdown, which means that you can use:
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                          • Unordered or ordered lists
                                                                                                                                                                                                                                                            • 
+
                                                                                                                                                                                                                                                          • Text formatting including bold and emphasis
                                                                                                                                                                                                                                                            • 
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          And numerous other Markdown features.
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Writing F# code
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Code that is not inside the comment will be formatted as
+a sample snippet.
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          /// The Hello World of functional languages!
+let rec factorial x =
+    if x = 0 then 1 else x * (factorial (x - 1))
+
+let f10 = factorial 10
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Hiding code
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          If you want to include some code in the source code,
+but omit it from the output, you can use the hide
+command.
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          The value will be defined in the F# code and so you
+can use it from other (visible) code and get the correct
+tooltips:
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          let answer = hidden
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Moving code around
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Sometimes, it is useful to first explain some code that
+has to be located at the end of the snippet (perhaps
+because it uses some definitions discussed in the middle).
+This can be done using include and define commands.
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          The following snippet gets the correct tooltips, even though
+it uses laterFunction:
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          let sample = laterFunction () |> printfn "Got: %s"
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          Then, we can explain how laterFunction is defined:
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          let laterFunction () = "Not very difficult, is it?"
+
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          This example covers pretty much all features that are
+currently implemented in literate.fsx, but feel free
+to fork the project on GitHub and add more
+features or report bugs!
                                                                                                                                                                                                                                                          
+
+        
                                                                                                                                                                                                                                                          val factorial: x: int -> int
                                                                                                                                                                                                                                                           The Hello World of functional languages!
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val x: int
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val f10: int
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val hidden: int
                                                                                                                                                                                                                                                           This is a hidden answer
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val answer: int
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val laterFunction: unit -> string
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val sample: unit
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          val printfn: format: Printf.TextWriterFormat<'T> -> 'T
                                                                                                                                                                                                                                                          
+
+    
                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                          
+
+
+    
+    
                                                                                                                                                                                                                                                          
+        
                                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                                            Type something to start searching.
                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/sidebyside/sidescript.ipynb b/sidebyside/sidescript.ipynb
new file mode 100644
index 000000000..8311a4568
--- /dev/null
+++ b/sidebyside/sidescript.ipynb
@@ -0,0 +1,189 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Example: Using Literate Script Content\n",
+    "\n",
+    "This file demonstrates how to write literate F# script\n",
+    "files (`*.fsx`) that can be transformed into nice HTML\n",
+    "using the `literate.fsx` script from the [F# Formatting\n",
+    "package](http://fsprojects.github.io/FSharp.Formatting).\n",
+    "\n",
+    "As you can see, a comment starting with a double asterisk\n",
+    "is treated as part of the document and is transformed\n",
+    "using Markdown, which means that you can use:\n",
+    "\n",
+    "* Unordered or ordered lists\n",
+    "\n",
+    "* Text formatting including **bold** and **emphasis**\n",
+    "\n",
+    "And numerous other [Markdown](http://daringfireball.net/projects/markdown) features.\n",
+    "\n",
+    "## Writing F# code\n",
+    "\n",
+    "Code that is not inside the comment will be formatted as\n",
+    "a sample snippet.\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "/// The Hello World of functional languages!\n",
+    "let rec factorial x =\n",
+    "    if x = 0 then 1 else x * (factorial (x - 1))\n",
+    "\n",
+    "let f10 = factorial 10\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "## Hiding code\n",
+    "\n",
+    "If you want to include some code in the source code,\n",
+    "but omit it from the output, you can use the `hide`\n",
+    "command.\n",
+    "\n",
+    "The value will be defined in the F# code and so you\n",
+    "can use it from other (visible) code and get the correct\n",
+    "tooltips:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let answer = hidden\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "## Moving code around\n",
+    "\n",
+    "Sometimes, it is useful to first explain some code that\n",
+    "has to be located at the end of the snippet (perhaps\n",
+    "because it uses some definitions discussed in the middle).\n",
+    "This can be done using `include` and `define` commands.\n",
+    "\n",
+    "The following snippet gets the correct tooltips, even though\n",
+    "it uses `laterFunction`:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let sample = laterFunction () |\u003e printfn \"Got: %s\"\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "Then, we can explain how `laterFunction` is defined:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "let laterFunction () = \"Not very difficult, is it?\"\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "This example covers pretty much all features that are\n",
+    "currently implemented in `literate.fsx`, but feel free\n",
+    "to [fork the project on GitHub](https://github.com/fsprojects/FSharp.Formatting) and add more\n",
+    "features or report bugs!\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/sidebyside/sidescript.md b/sidebyside/sidescript.md
new file mode 100644
index 000000000..7d3b09fbf
--- /dev/null
+++ b/sidebyside/sidescript.md
@@ -0,0 +1,70 @@
+# Example: Using Literate Script Content
+
+This file demonstrates how to write literate F# script
+files (`*.fsx`) that can be transformed into nice HTML
+using the `literate.fsx` script from the [F# Formatting
+package](http://fsprojects.github.io/FSharp.Formatting).
+
+As you can see, a comment starting with a double asterisk
+is treated as part of the document and is transformed
+using Markdown, which means that you can use:
+
+* Unordered or ordered lists
+
+* Text formatting including **bold** and **emphasis**
+
+And numerous other [Markdown](http://daringfireball.net/projects/markdown) features.
+
+## Writing F# code
+
+Code that is not inside the comment will be formatted as
+a sample snippet.
+
+```fsharp
+/// The Hello World of functional languages!
+let rec factorial x =
+    if x = 0 then 1 else x * (factorial (x - 1))
+
+let f10 = factorial 10
+```
+
+## Hiding code
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the `hide`
+command.
+
+The value will be defined in the F# code and so you
+can use it from other (visible) code and get the correct
+tooltips:
+
+```fsharp
+let answer = hidden
+```
+
+## Moving code around
+
+Sometimes, it is useful to first explain some code that
+has to be located at the end of the snippet (perhaps
+because it uses some definitions discussed in the middle).
+This can be done using `include` and `define` commands.
+
+The following snippet gets the correct tooltips, even though
+it uses `laterFunction`:
+
+```fsharp
+let sample = laterFunction () |> printfn "Got: %s"
+```
+
+Then, we can explain how `laterFunction` is defined:
+
+```fsharp
+let laterFunction () = "Not very difficult, is it?"
+```
+
+This example covers pretty much all features that are
+currently implemented in `literate.fsx`, but feel free
+to [fork the project on GitHub](https://github.com/fsprojects/FSharp.Formatting) and add more
+features or report bugs!
+
+
diff --git a/sidebyside/sidescript.tex b/sidebyside/sidescript.tex
new file mode 100644
index 000000000..d7d6d75d4
--- /dev/null
+++ b/sidebyside/sidescript.tex
@@ -0,0 +1,143 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Example: Using Literate Script Content}
+
+
+
+This file demonstrates how to write literate F\# script
+files (\texttt{*.fsx}) that can be transformed into nice HTML
+using the \texttt{literate.fsx} script from the \href{http://fsprojects.github.io/FSharp.Formatting}{F\# Formatting
+package}.
+
+
+As you can see, a comment starting with a double asterisk
+is treated as part of the document and is transformed
+using Markdown, which means that you can use:
+\begin{itemize}
+\item Unordered or ordered lists
+
+\item Text formatting including \textbf{bold} and \emph{emphasis}
+
+\end{itemize}
+
+
+
+And numerous other \href{http://daringfireball.net/projects/markdown}{Markdown} features.
+\subsection*{Writing F\# code}
+
+
+
+Code that is not inside the comment will be formatted as
+a sample snippet.
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\com{/// The Hello World of functional languages!}
+\kwd{let} \kwd{rec} \lfun{factorial} \lfun{x} \ops{=}
+    \kwd{if} \lfun{x} \ops{=} \num{0} \kwd{then} \num{1} \kwd{else} \lfun{x} \ops{*} {(}\lfun{factorial} {(}\lfun{x} \ops{-} \num{1}{)}{)}
+
+\kwd{let} \id{f10} \ops{=} \lfun{factorial} \num{10}
+
+\end{lstlisting}
+
+\subsection*{Hiding code}
+
+
+
+If you want to include some code in the source code,
+but omit it from the output, you can use the \texttt{hide}
+command.
+
+
+The value will be defined in the F\# code and so you
+can use it from other (visible) code and get the correct
+tooltips:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{answer} \ops{=} \id{hidden}
+
+\end{lstlisting}
+
+\subsection*{Moving code around}
+
+
+
+Sometimes, it is useful to first explain some code that
+has to be located at the end of the snippet (perhaps
+because it uses some definitions discussed in the middle).
+This can be done using \texttt{include} and \texttt{define} commands.
+
+
+The following snippet gets the correct tooltips, even though
+it uses \texttt{laterFunction}:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \id{sample} \ops{=} \lfun{laterFunction} {(}{)} \ops{|>} \lfun{printfn} \str{"Got: }\lprf{\%s}\str{"}
+
+\end{lstlisting}
+
+
+
+Then, we can explain how \texttt{laterFunction} is defined:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\kwd{let} \lfun{laterFunction} {(}{)} \ops{=} \str{"Not very difficult, is it?"}
+
+\end{lstlisting}
+
+
+
+This example covers pretty much all features that are
+currently implemented in \texttt{literate.fsx}, but feel free
+to \href{https://github.com/fsprojects/FSharp.Formatting}{fork the project on GitHub} and add more
+features or report bugs!
+
+
+\end{document}
\ No newline at end of file
diff --git a/styling.fsx b/styling.fsx
new file mode 100644
index 000000000..aae390320
--- /dev/null
+++ b/styling.fsx
@@ -0,0 +1,212 @@
+(**
+# Customization and Styling
+
+When using `fsdocs`, there are six levels of extra content development and styling.
+
+0 Don't do any styling or documentation customization and simply write content. This is by far the simplest option to
+maintain.
+  
+
+1 Add content such as an `docs/index.md` to customize the front-page content for your generated docs.
+You can also add content such as `docs/reference/fslib.md` to give a bespoke landing page
+for one of your namespaces, e.g. here assumed to be `namespace FsLib`. This will override any
+generated content.
+  
+
+2 Customize via Styling Parameters
+  
+
+3 Customize via CSS
+  
+
+4 Customize via a new template
+  
+
+5 Customize by generating your own site using your own code
+  
+
+By default `fsdocs` does no styling customization and uses the following defaults. These are the settings used to build
+this site.
+
+* Uses the default template
+in [docs/_template.html](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/_template.html)
+  
+
+* Uses the default styles
+in [docs/content/fsdocs-default.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).
+  
+
+* Uses no custom styles
+in [docs/content/fsdocs-custom.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).
+  
+
+* Uses no styling parameters except those extracted from the project files.
+  
+
+For your project, you don't need any of these files. However, you can add them if you wish, though if
+you adjust them there is no guarantee that your template will continue to work with future versions of F# Formatting.
+
+## Customizing via Styling Parameters
+
+The following [content parameters](content.html) are particularly related to visual styling:
+
+Substitution name | Value (if not overriden by --parameters)
+:--- | :---
+`fsdocs-authors` | ``
+`fsdocs-license-link` | ``
+`fsdocs-logo-src` | ``
+`fsdocs-favicon-src` | ``
+`fsdocs-logo-link` | ``
+`fsdocs-release-notes-link` | `` else `/blob/master/RELEASE_NOTES.md`
+`fsdocs-repository-link` | ``
+`fsdocs-theme` | ``, must currently be `default`
+
+
+These basic entry-level styling parameters can be set in the project file or `Directory.Build.props`.
+For example:
+
+```xml
+
+    
+    https://github.com/foo/bar/blob/master/License.txt
+    https://foo.github.io/bar/
+    https://github.com/foo/bar/
+    https://fsharp.org
+    img/logo.png
+    img/favicon.ico
+    https://github.com/foo/bar/blob/master/License.txt
+    https://github.com/foo/bar/blob/master/release-notes.md
+    true
+    default
+
+```
+
+As an example, here is [a page with alternative styling](templates/leftside/styling.html).
+
+## Customizing via CSS
+
+You can start styling by creating a file `docs/content/fsdocs-theme.css` and adding entries to it.
+It is loaded by the standard template.
+
+### CSS variables
+
+The default template is heavily based
+on [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). These can easily be
+override to customize the look and feel of the default theme.
+A full list of the overrideable variables can be
+found [here](https://github.com/fsprojects/FSharp.Formatting/blob/main/docs/content/fsdocs-default.css).
+
+```css
+:root {
+    --text-color: red;
+}
+
+[data-theme=dark] {
+    --text-color: darkred;
+}
+```
+
+Please be aware that the `dark` mode in the default theme is using the same variables.
+When you override a variable, it will also be used in `dark` mode unless redefined in a `[data-theme=dark]` CSS query.
+
+### CSS classes
+
+The API documentation uses a set of fixed CSS classes:
+
+CSS class | Corresponding Content
+:--- | :---
+`.fsdocs-tip` | generated tooltips
+`.fsdocs-xmldoc` | generated xmldoc sections
+`.fsdocs-member-list` | generated member lists (tables)
+`.fsdocs-member-usage` | usage in generated member lists
+`.fsdocs-member-tooltip` | tooltips in generated member lists
+`.fsdocs-member-xmldoc` | documentation in generated member lists
+`.fsdocs-entity-list` | generated entity lists
+`.fsdocs-entity-name` | generated entity lists
+`.fsdocs-entity-xmldoc` | documentation in generated entity lists
+`.fsdocs-exception-list` | generated exception lists
+`.fsdocs-summary` | the 'summary' section of an XML doc
+`.fsdocs-remarks` | the 'remarks' section of an XML doc
+`.fsdocs-params` | the 'parameters' section of an XML doc
+`.fsdocs-param` | a 'parameter' section of an XML doc
+`.fsdocs-param-name` | a 'parameter' name of an XML doc
+`.fsdocs-returns` | the 'returns' section of an XML doc
+`.fsdocs-example` | the 'example' section of an XML doc
+`.fsdocs-note` | the 'notes' section of an XML doc
+`.fsdocs-para` | a paragraph of an XML doc
+
+
+Some generated elements are given specific HTML ids:
+
+HTML element selector | Content
+:--- | :---
+`header` | The navigation-bar
+`#fsdocs-main-menu` | The main menu on the left side
+`#content` | The generated content
+`#fsdocs-page-menu` | The sub menu on the right side
+`dialog` | The search dialog
+`dialog input[type=search]` | The search box
+`#fsdocs-logo` | The logo
+
+
+If you write a new theme by CSS styling please contribute it back to FSharp.Formatting.
+
+## Customizing via a new template
+
+You can do advanced styling by creating a new template. Add a file `docs/_template.html`, likely starting
+with the existing default template.
+
+> NOTE: To enable hot reload during development with `fsdocs watch` in a custom `_template.html` file,
+make sure to add the single line `{{fsdocs-watch-script}}`  to your `` tag.
+NOTE: There is no guarantee that your template will continue to work with future versions of F# Formatting.
+If you do develop a good template please consider contributing it back to F# Formatting.
+> 
+
+## Customizing menu items by template
+
+You can add advanced styling to the sidebar generated menu items by creating a new template for it.
+`fsdoc` will look for menu templates in the `--input` folder, which defaults to the docs folder.
+
+To customize the generated menu-item headers, use file `_menu_template.html` with starting template:
+
+```html
+
                                                                                                                                                                                                                                                          • 
+    {{fsdocs-menu-header-content}}
+
                                                                                                                                                                                                                                                            • 
+{{fsdocs-menu-items}}
+```
+
+Similarly, to customize the individual menu item list, use file `_menu-item_template.html` with the starting template:
+
+```html
+
                                                                                                                                                                                                                                                          • {{fsdocs-menu-item-content}}
                                                                                                                                                                                                                                                            • 
+```
+
+Do note that files must be added before running, or won't be generated.
+In case you want to get a unique identifier for a header or menu item, you can use `{{fsdocs-menu-header-id}}`
+and `{{fsdocs-menu-item-id}}`, respectively.
+
+## Injecting additional html into the default template
+
+Occasionally, you may find the need to make small customizations to the default template, such as adding a Google
+Analytics snippet or including additional style or script tags. To address this scenario, you can create two
+files: `_head.html` and/or `_body.html`.
+
+The content within these files will serve as replacements for the `{{fsdocs-head-extra}}` and `{{fsdocs-body-extra}}`
+placeholders, which are utilized in the default template.
+
+## Customizing by generating your own site using your own code
+
+The `FSharp.Formatting.ApiDocs` namespace includes a `GenerateModel` that captures
+the results of documentation preparation in `ApiDocsModel` and allows you to
+generate your own site using your own code.
+
+> NOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site
+generation will continue to work
+with future versions of F# Formatting.
+NOTE: The `ApiDocsModel` currently includes some generated HTML with some specific style tags.
+In the long term these may be removed from the design of that component.
+> 
+
+*)
+
diff --git a/styling.html b/styling.html
new file mode 100644
index 000000000..4c9de2969
--- /dev/null
+++ b/styling.html
@@ -0,0 +1,653 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Customization and Styling
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                            
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                            
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                            
+        
+
                                                                                                                                                                                                                                                            Customization and Styling
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            When using fsdocs, there are six levels of extra content development and styling.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                            1. 
+
                                                                                                                                                                                                                                                              Don't do any styling or documentation customization and simply write content. This is by far the simplest option to
+maintain.
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              2. 
+
                                                                                                                                                                                                                                                            2. 
+
                                                                                                                                                                                                                                                              Add content such as an docs/index.md to customize the front-page content for your generated docs.
+You can also add content such as docs/reference/fslib.md to give a bespoke landing page
+for one of your namespaces, e.g. here assumed to be namespace FsLib. This will override any
+generated content.
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              3. 
+
                                                                                                                                                                                                                                                            3. Customize via Styling Parameters
                                                                                                                                                                                                                                                              4. 
+
                                                                                                                                                                                                                                                            4. Customize via CSS
                                                                                                                                                                                                                                                              5. 
+
                                                                                                                                                                                                                                                            5. Customize via a new template
                                                                                                                                                                                                                                                              6. 
+
                                                                                                                                                                                                                                                            6. Customize by generating your own site using your own code
                                                                                                                                                                                                                                                              7. 
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            By default fsdocs does no styling customization and uses the following defaults. These are the settings used to build
+this site.
                                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                                            For your project, you don't need any of these files. However, you can add them if you wish, though if
+you adjust them there is no guarantee that your template will continue to work with future versions of F# Formatting.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Customizing via Styling Parameters
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            The following content parameters are particularly related to visual styling:
                                                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                                                                            Substitution name
                                                                                                                                                                                                                                                            Value (if not overriden by --parameters)
                                                                                                                                                                                                                                                            fsdocs-authors
                                                                                                                                                                                                                                                            <Authors>
                                                                                                                                                                                                                                                            fsdocs-license-link
                                                                                                                                                                                                                                                            <FsDocsLicenseLink>
                                                                                                                                                                                                                                                            fsdocs-logo-src
                                                                                                                                                                                                                                                            <FsDocsLogoSource>
                                                                                                                                                                                                                                                            fsdocs-favicon-src
                                                                                                                                                                                                                                                            <FsDocsFaviconSource>
                                                                                                                                                                                                                                                            fsdocs-logo-link
                                                                                                                                                                                                                                                            <FsDocsLogoLink>
                                                                                                                                                                                                                                                            fsdocs-release-notes-link
                                                                                                                                                                                                                                                            <FsDocsReleaseNotesLink> else <PackageProjectUrl>/blob/master/RELEASE_NOTES.md
                                                                                                                                                                                                                                                            fsdocs-repository-link
                                                                                                                                                                                                                                                            <RepositoryUrl>
                                                                                                                                                                                                                                                            fsdocs-theme
                                                                                                                                                                                                                                                            <FsDocsTheme>, must currently be default
                                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                                            These basic entry-level styling parameters can be set in the project file or Directory.Build.props.
+For example:
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            <PropertyGroup>
+    <!-- Example ultra-simple styling and generation settings for FsDocs default template-->
+    <PackageLicenseUrl>https://github.com/foo/bar/blob/master/License.txt</PackageLicenseUrl>
+    <PackageProjectUrl>https://foo.github.io/bar/</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/foo/bar/</RepositoryUrl>
+    <FsDocsLogoLink>https://fsharp.org</FsDocsLogoLink>
+    <FsDocsLogoSource>img/logo.png</FsDocsLogoSource>
+    <FsDocsFaviconSource>img/favicon.ico</FsDocsFaviconSource>
+    <FsDocsLicenseLink>https://github.com/foo/bar/blob/master/License.txt</FsDocsLicenseLink>
+    <FsDocsReleaseNotesLink>https://github.com/foo/bar/blob/master/release-notes.md</FsDocsReleaseNotesLink>
+    <FsDocsWarnOnMissingDocs>true</FsDocsWarnOnMissingDocs>
+    <FsDocsTheme>default</FsDocsTheme>
+</PropertyGroup>
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            As an example, here is a page with alternative styling.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Customizing via CSS
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            You can start styling by creating a file docs/content/fsdocs-theme.css and adding entries to it.
                                                                                                                                                                                                                                                            
+It is loaded by the standard template.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            CSS variables
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            The default template is heavily based
+on CSS variables. These can easily be
+override to customize the look and feel of the default theme.
                                                                                                                                                                                                                                                            
+A full list of the overrideable variables can be
+found here.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            :root {
+    --text-color: red;
+}
+
+[data-theme=dark] {
+    --text-color: darkred;
+}
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Please be aware that the dark mode in the default theme is using the same variables.
+When you override a variable, it will also be used in dark mode unless redefined in a [data-theme=dark] CSS query.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            CSS classes
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            The API documentation uses a set of fixed CSS classes:
                                                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                                                                            CSS class
                                                                                                                                                                                                                                                            Corresponding Content
                                                                                                                                                                                                                                                            .fsdocs-tip
                                                                                                                                                                                                                                                            generated tooltips
                                                                                                                                                                                                                                                            .fsdocs-xmldoc
                                                                                                                                                                                                                                                            generated xmldoc sections
                                                                                                                                                                                                                                                            .fsdocs-member-list
                                                                                                                                                                                                                                                            generated member lists (tables)
                                                                                                                                                                                                                                                            .fsdocs-member-usage
                                                                                                                                                                                                                                                            usage in generated member lists
                                                                                                                                                                                                                                                            .fsdocs-member-tooltip
                                                                                                                                                                                                                                                            tooltips in generated member lists
                                                                                                                                                                                                                                                            .fsdocs-member-xmldoc
                                                                                                                                                                                                                                                            documentation in generated member lists
                                                                                                                                                                                                                                                            .fsdocs-entity-list
                                                                                                                                                                                                                                                            generated entity lists
                                                                                                                                                                                                                                                            .fsdocs-entity-name
                                                                                                                                                                                                                                                            generated entity lists
                                                                                                                                                                                                                                                            .fsdocs-entity-xmldoc
                                                                                                                                                                                                                                                            documentation in generated entity lists
                                                                                                                                                                                                                                                            .fsdocs-exception-list
                                                                                                                                                                                                                                                            generated exception lists
                                                                                                                                                                                                                                                            .fsdocs-summary
                                                                                                                                                                                                                                                            the 'summary' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-remarks
                                                                                                                                                                                                                                                            the 'remarks' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-params
                                                                                                                                                                                                                                                            the 'parameters' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-param
                                                                                                                                                                                                                                                            a 'parameter' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-param-name
                                                                                                                                                                                                                                                            a 'parameter' name of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-returns
                                                                                                                                                                                                                                                            the 'returns' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-example
                                                                                                                                                                                                                                                            the 'example' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-note
                                                                                                                                                                                                                                                            the 'notes' section of an XML doc
                                                                                                                                                                                                                                                            .fsdocs-para
                                                                                                                                                                                                                                                            a paragraph of an XML doc
                                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                                            Some generated elements are given specific HTML ids:
                                                                                                                                                                                                                                                            
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                                                                            HTML element selector
                                                                                                                                                                                                                                                            Content
                                                                                                                                                                                                                                                            header
                                                                                                                                                                                                                                                            The navigation-bar
                                                                                                                                                                                                                                                            #fsdocs-main-menu
                                                                                                                                                                                                                                                            The main menu on the left side
                                                                                                                                                                                                                                                            #content
                                                                                                                                                                                                                                                            The generated content
                                                                                                                                                                                                                                                            #fsdocs-page-menu
                                                                                                                                                                                                                                                            The sub menu on the right side
                                                                                                                                                                                                                                                            dialog
                                                                                                                                                                                                                                                            The search dialog
                                                                                                                                                                                                                                                            dialog input[type=search]
                                                                                                                                                                                                                                                            The search box
                                                                                                                                                                                                                                                            #fsdocs-logo
                                                                                                                                                                                                                                                            The logo
                                                                                                                                                                                                                                                            
+
+
                                                                                                                                                                                                                                                            If you write a new theme by CSS styling please contribute it back to FSharp.Formatting.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Customizing via a new template
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            You can do advanced styling by creating a new template. Add a file docs/_template.html, likely starting
+with the existing default template.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            NOTE: To enable hot reload during development with fsdocs watch in a custom _template.html file,
+make sure to add the single line {{fsdocs-watch-script}}  to your <head> tag.
+NOTE: There is no guarantee that your template will continue to work with future versions of F# Formatting.
+If you do develop a good template please consider contributing it back to F# Formatting.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Customizing menu items by template
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            You can add advanced styling to the sidebar generated menu items by creating a new template for it.
+fsdoc will look for menu templates in the --input folder, which defaults to the docs folder.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            To customize the generated menu-item headers, use file _menu_template.html with starting template:
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            <li class="nav-header">
+    {{fsdocs-menu-header-content}}
+</li>
+{{fsdocs-menu-items}}
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Similarly, to customize the individual menu item list, use file _menu-item_template.html with the starting template:
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            <li class="nav-item"><a href="{{fsdocs-menu-item-link}}" class="nav-link">{{fsdocs-menu-item-content}}</a></li>
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Do note that files must be added before running, or won't be generated.
+In case you want to get a unique identifier for a header or menu item, you can use {{fsdocs-menu-header-id}}
+and {{fsdocs-menu-item-id}}, respectively.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Injecting additional html into the default template
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Occasionally, you may find the need to make small customizations to the default template, such as adding a Google
+Analytics snippet or including additional style or script tags. To address this scenario, you can create two
+files: _head.html and/or _body.html.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            The content within these files will serve as replacements for the {{fsdocs-head-extra}} and {{fsdocs-body-extra}}
+placeholders, which are utilized in the default template.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            Customizing by generating your own site using your own code
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            The FSharp.Formatting.ApiDocs namespace includes a GenerateModel that captures
+the results of documentation preparation in ApiDocsModel and allows you to
+generate your own site using your own code.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            NOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site
+generation will continue to work
+with future versions of F# Formatting.
+NOTE: The ApiDocsModel currently includes some generated HTML with some specific style tags.
+In the long term these may be removed from the design of that component.
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
+        
+    
                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                            
+
+
+    
+    
                                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                                              Type something to start searching.
                                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                              
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/styling.ipynb b/styling.ipynb
new file mode 100644
index 000000000..789f18fa3
--- /dev/null
+++ b/styling.ipynb
@@ -0,0 +1,249 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Customization and Styling\n",
+    "\n",
+    "When using `fsdocs`, there are six levels of extra content development and styling.\n",
+    "\n",
+    "0 Don\u0027t do any styling or documentation customization and simply write content. This is by far the simplest option to\n",
+    "maintain.\n",
+    "  \n",
+    "\n",
+    "1 Add content such as an `docs/index.md` to customize the front-page content for your generated docs.\n",
+    "You can also add content such as `docs/reference/fslib.md` to give a bespoke landing page\n",
+    "for one of your namespaces, e.g. here assumed to be `namespace FsLib`. This will override any\n",
+    "generated content.\n",
+    "  \n",
+    "\n",
+    "2 Customize via Styling Parameters\n",
+    "  \n",
+    "\n",
+    "3 Customize via CSS\n",
+    "  \n",
+    "\n",
+    "4 Customize via a new template\n",
+    "  \n",
+    "\n",
+    "5 Customize by generating your own site using your own code\n",
+    "  \n",
+    "\n",
+    "By default `fsdocs` does no styling customization and uses the following defaults. These are the settings used to build\n",
+    "this site.\n",
+    "\n",
+    "* Uses the default template\n",
+    "in [docs/_template.html](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/_template.html)\n",
+    "  \n",
+    "\n",
+    "* Uses the default styles\n",
+    "in [docs/content/fsdocs-default.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).\n",
+    "  \n",
+    "\n",
+    "* Uses no custom styles\n",
+    "in [docs/content/fsdocs-custom.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).\n",
+    "  \n",
+    "\n",
+    "* Uses no styling parameters except those extracted from the project files.\n",
+    "  \n",
+    "\n",
+    "For your project, you don\u0027t need any of these files. However, you can add them if you wish, though if\n",
+    "you adjust them there is no guarantee that your template will continue to work with future versions of F# Formatting.\n",
+    "\n",
+    "## Customizing via Styling Parameters\n",
+    "\n",
+    "The following [content parameters](content.html) are particularly related to visual styling:\n",
+    "\n",
+    "Substitution name | Value (if not overriden by --parameters)\n",
+    ":--- | :---\n",
+    "`fsdocs-authors` | `\u003cAuthors\u003e`\n",
+    "`fsdocs-license-link` | `\u003cFsDocsLicenseLink\u003e`\n",
+    "`fsdocs-logo-src` | `\u003cFsDocsLogoSource\u003e`\n",
+    "`fsdocs-favicon-src` | `\u003cFsDocsFaviconSource\u003e`\n",
+    "`fsdocs-logo-link` | `\u003cFsDocsLogoLink\u003e`\n",
+    "`fsdocs-release-notes-link` | `\u003cFsDocsReleaseNotesLink\u003e` else `\u003cPackageProjectUrl\u003e/blob/master/RELEASE_NOTES.md`\n",
+    "`fsdocs-repository-link` | `\u003cRepositoryUrl\u003e`\n",
+    "`fsdocs-theme` | `\u003cFsDocsTheme\u003e`, must currently be `default`\n",
+    "\n",
+    "\n",
+    "These basic entry-level styling parameters can be set in the project file or `Directory.Build.props`.\n",
+    "For example:\n",
+    "\n",
+    "```xml\n",
+    "\u003cPropertyGroup\u003e\n",
+    "    \u003c!-- Example ultra-simple styling and generation settings for FsDocs default template--\u003e\n",
+    "    \u003cPackageLicenseUrl\u003ehttps://github.com/foo/bar/blob/master/License.txt\u003c/PackageLicenseUrl\u003e\n",
+    "    \u003cPackageProjectUrl\u003ehttps://foo.github.io/bar/\u003c/PackageProjectUrl\u003e\n",
+    "    \u003cRepositoryUrl\u003ehttps://github.com/foo/bar/\u003c/RepositoryUrl\u003e\n",
+    "    \u003cFsDocsLogoLink\u003ehttps://fsharp.org\u003c/FsDocsLogoLink\u003e\n",
+    "    \u003cFsDocsLogoSource\u003eimg/logo.png\u003c/FsDocsLogoSource\u003e\n",
+    "    \u003cFsDocsFaviconSource\u003eimg/favicon.ico\u003c/FsDocsFaviconSource\u003e\n",
+    "    \u003cFsDocsLicenseLink\u003ehttps://github.com/foo/bar/blob/master/License.txt\u003c/FsDocsLicenseLink\u003e\n",
+    "    \u003cFsDocsReleaseNotesLink\u003ehttps://github.com/foo/bar/blob/master/release-notes.md\u003c/FsDocsReleaseNotesLink\u003e\n",
+    "    \u003cFsDocsWarnOnMissingDocs\u003etrue\u003c/FsDocsWarnOnMissingDocs\u003e\n",
+    "    \u003cFsDocsTheme\u003edefault\u003c/FsDocsTheme\u003e\n",
+    "\u003c/PropertyGroup\u003e\n",
+    "```\n",
+    "\n",
+    "As an example, here is [a page with alternative styling](templates/leftside/styling.html).\n",
+    "\n",
+    "## Customizing via CSS\n",
+    "\n",
+    "You can start styling by creating a file `docs/content/fsdocs-theme.css` and adding entries to it.\n",
+    "It is loaded by the standard template.\n",
+    "\n",
+    "### CSS variables\n",
+    "\n",
+    "The default template is heavily based\n",
+    "on [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). These can easily be\n",
+    "override to customize the look and feel of the default theme.\n",
+    "A full list of the overrideable variables can be\n",
+    "found [here](https://github.com/fsprojects/FSharp.Formatting/blob/main/docs/content/fsdocs-default.css).\n",
+    "\n",
+    "```css\n",
+    ":root {\n",
+    "    --text-color: red;\n",
+    "}\n",
+    "\n",
+    "[data-theme=dark] {\n",
+    "    --text-color: darkred;\n",
+    "}\n",
+    "```\n",
+    "\n",
+    "Please be aware that the `dark` mode in the default theme is using the same variables.\n",
+    "When you override a variable, it will also be used in `dark` mode unless redefined in a `[data-theme=dark]` CSS query.\n",
+    "\n",
+    "### CSS classes\n",
+    "\n",
+    "The API documentation uses a set of fixed CSS classes:\n",
+    "\n",
+    "CSS class | Corresponding Content\n",
+    ":--- | :---\n",
+    "`.fsdocs-tip` | generated tooltips\n",
+    "`.fsdocs-xmldoc` | generated xmldoc sections\n",
+    "`.fsdocs-member-list` | generated member lists (tables)\n",
+    "`.fsdocs-member-usage` | usage in generated member lists\n",
+    "`.fsdocs-member-tooltip` | tooltips in generated member lists\n",
+    "`.fsdocs-member-xmldoc` | documentation in generated member lists\n",
+    "`.fsdocs-entity-list` | generated entity lists\n",
+    "`.fsdocs-entity-name` | generated entity lists\n",
+    "`.fsdocs-entity-xmldoc` | documentation in generated entity lists\n",
+    "`.fsdocs-exception-list` | generated exception lists\n",
+    "`.fsdocs-summary` | the \u0027summary\u0027 section of an XML doc\n",
+    "`.fsdocs-remarks` | the \u0027remarks\u0027 section of an XML doc\n",
+    "`.fsdocs-params` | the \u0027parameters\u0027 section of an XML doc\n",
+    "`.fsdocs-param` | a \u0027parameter\u0027 section of an XML doc\n",
+    "`.fsdocs-param-name` | a \u0027parameter\u0027 name of an XML doc\n",
+    "`.fsdocs-returns` | the \u0027returns\u0027 section of an XML doc\n",
+    "`.fsdocs-example` | the \u0027example\u0027 section of an XML doc\n",
+    "`.fsdocs-note` | the \u0027notes\u0027 section of an XML doc\n",
+    "`.fsdocs-para` | a paragraph of an XML doc\n",
+    "\n",
+    "\n",
+    "Some generated elements are given specific HTML ids:\n",
+    "\n",
+    "HTML element selector | Content\n",
+    ":--- | :---\n",
+    "`header` | The navigation-bar\n",
+    "`#fsdocs-main-menu` | The main menu on the left side\n",
+    "`#content` | The generated content\n",
+    "`#fsdocs-page-menu` | The sub menu on the right side\n",
+    "`dialog` | The search dialog\n",
+    "`dialog input[type=search]` | The search box\n",
+    "`#fsdocs-logo` | The logo\n",
+    "\n",
+    "\n",
+    "If you write a new theme by CSS styling please contribute it back to FSharp.Formatting.\n",
+    "\n",
+    "## Customizing via a new template\n",
+    "\n",
+    "You can do advanced styling by creating a new template. Add a file `docs/_template.html`, likely starting\n",
+    "with the existing default template.\n",
+    "\n",
+    "\u003e NOTE: To enable hot reload during development with `fsdocs watch` in a custom `_template.html` file,\n",
+    "make sure to add the single line `{{fsdocs-watch-script}}`  to your `\u003chead\u003e` tag.\n",
+    "NOTE: There is no guarantee that your template will continue to work with future versions of F# Formatting.\n",
+    "If you do develop a good template please consider contributing it back to F# Formatting.\n",
+    "\u003e \n",
+    "\n",
+    "## Customizing menu items by template\n",
+    "\n",
+    "You can add advanced styling to the sidebar generated menu items by creating a new template for it.\n",
+    "`fsdoc` will look for menu templates in the `--input` folder, which defaults to the docs folder.\n",
+    "\n",
+    "To customize the generated menu-item headers, use file `_menu_template.html` with starting template:\n",
+    "\n",
+    "```html\n",
+    "\u003cli class=\"nav-header\"\u003e\n",
+    "    {{fsdocs-menu-header-content}}\n",
+    "\u003c/li\u003e\n",
+    "{{fsdocs-menu-items}}\n",
+    "```\n",
+    "\n",
+    "Similarly, to customize the individual menu item list, use file `_menu-item_template.html` with the starting template:\n",
+    "\n",
+    "```html\n",
+    "\u003cli class=\"nav-item\"\u003e\u003ca href=\"{{fsdocs-menu-item-link}}\" class=\"nav-link\"\u003e{{fsdocs-menu-item-content}}\u003c/a\u003e\u003c/li\u003e\n",
+    "```\n",
+    "\n",
+    "Do note that files must be added before running, or won\u0027t be generated.\n",
+    "In case you want to get a unique identifier for a header or menu item, you can use `{{fsdocs-menu-header-id}}`\n",
+    "and `{{fsdocs-menu-item-id}}`, respectively.\n",
+    "\n",
+    "## Injecting additional html into the default template\n",
+    "\n",
+    "Occasionally, you may find the need to make small customizations to the default template, such as adding a Google\n",
+    "Analytics snippet or including additional style or script tags. To address this scenario, you can create two\n",
+    "files: `_head.html` and/or `_body.html`.\n",
+    "\n",
+    "The content within these files will serve as replacements for the `{{fsdocs-head-extra}}` and `{{fsdocs-body-extra}}`\n",
+    "placeholders, which are utilized in the default template.\n",
+    "\n",
+    "## Customizing by generating your own site using your own code\n",
+    "\n",
+    "The `FSharp.Formatting.ApiDocs` namespace includes a `GenerateModel` that captures\n",
+    "the results of documentation preparation in `ApiDocsModel` and allows you to\n",
+    "generate your own site using your own code.\n",
+    "\n",
+    "\u003e NOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site\n",
+    "generation will continue to work\n",
+    "with future versions of F# Formatting.\n",
+    "NOTE: The `ApiDocsModel` currently includes some generated HTML with some specific style tags.\n",
+    "In the long term these may be removed from the design of that component.\n",
+    "\u003e \n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/styling.md b/styling.md
new file mode 100644
index 000000000..12764abcc
--- /dev/null
+++ b/styling.md
@@ -0,0 +1,210 @@
+# Customization and Styling
+
+When using `fsdocs`, there are six levels of extra content development and styling.
+
+0 Don't do any styling or documentation customization and simply write content. This is by far the simplest option to
+maintain.
+  
+
+1 Add content such as an `docs/index.md` to customize the front-page content for your generated docs.
+You can also add content such as `docs/reference/fslib.md` to give a bespoke landing page
+for one of your namespaces, e.g. here assumed to be `namespace FsLib`. This will override any
+generated content.
+  
+
+2 Customize via Styling Parameters
+  
+
+3 Customize via CSS
+  
+
+4 Customize via a new template
+  
+
+5 Customize by generating your own site using your own code
+  
+
+By default `fsdocs` does no styling customization and uses the following defaults. These are the settings used to build
+this site.
+
+* Uses the default template
+in [docs/_template.html](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/_template.html)
+  
+
+* Uses the default styles
+in [docs/content/fsdocs-default.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).
+  
+
+* Uses no custom styles
+in [docs/content/fsdocs-custom.css](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css).
+  
+
+* Uses no styling parameters except those extracted from the project files.
+  
+
+For your project, you don't need any of these files. However, you can add them if you wish, though if
+you adjust them there is no guarantee that your template will continue to work with future versions of F# Formatting.
+
+## Customizing via Styling Parameters
+
+The following [content parameters](content.html) are particularly related to visual styling:
+
+Substitution name | Value (if not overriden by --parameters)
+:--- | :---
+`fsdocs-authors` | ``
+`fsdocs-license-link` | ``
+`fsdocs-logo-src` | ``
+`fsdocs-favicon-src` | ``
+`fsdocs-logo-link` | ``
+`fsdocs-release-notes-link` | `` else `/blob/master/RELEASE_NOTES.md`
+`fsdocs-repository-link` | ``
+`fsdocs-theme` | ``, must currently be `default`
+
+
+These basic entry-level styling parameters can be set in the project file or `Directory.Build.props`.
+For example:
+
+```xml
+
+    
+    https://github.com/foo/bar/blob/master/License.txt
+    https://foo.github.io/bar/
+    https://github.com/foo/bar/
+    https://fsharp.org
+    img/logo.png
+    img/favicon.ico
+    https://github.com/foo/bar/blob/master/License.txt
+    https://github.com/foo/bar/blob/master/release-notes.md
+    true
+    default
+
+```
+
+As an example, here is [a page with alternative styling](templates/leftside/styling.html).
+
+## Customizing via CSS
+
+You can start styling by creating a file `docs/content/fsdocs-theme.css` and adding entries to it.
+It is loaded by the standard template.
+
+### CSS variables
+
+The default template is heavily based
+on [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties). These can easily be
+override to customize the look and feel of the default theme.
+A full list of the overrideable variables can be
+found [here](https://github.com/fsprojects/FSharp.Formatting/blob/main/docs/content/fsdocs-default.css).
+
+```css
+:root {
+    --text-color: red;
+}
+
+[data-theme=dark] {
+    --text-color: darkred;
+}
+```
+
+Please be aware that the `dark` mode in the default theme is using the same variables.
+When you override a variable, it will also be used in `dark` mode unless redefined in a `[data-theme=dark]` CSS query.
+
+### CSS classes
+
+The API documentation uses a set of fixed CSS classes:
+
+CSS class | Corresponding Content
+:--- | :---
+`.fsdocs-tip` | generated tooltips
+`.fsdocs-xmldoc` | generated xmldoc sections
+`.fsdocs-member-list` | generated member lists (tables)
+`.fsdocs-member-usage` | usage in generated member lists
+`.fsdocs-member-tooltip` | tooltips in generated member lists
+`.fsdocs-member-xmldoc` | documentation in generated member lists
+`.fsdocs-entity-list` | generated entity lists
+`.fsdocs-entity-name` | generated entity lists
+`.fsdocs-entity-xmldoc` | documentation in generated entity lists
+`.fsdocs-exception-list` | generated exception lists
+`.fsdocs-summary` | the 'summary' section of an XML doc
+`.fsdocs-remarks` | the 'remarks' section of an XML doc
+`.fsdocs-params` | the 'parameters' section of an XML doc
+`.fsdocs-param` | a 'parameter' section of an XML doc
+`.fsdocs-param-name` | a 'parameter' name of an XML doc
+`.fsdocs-returns` | the 'returns' section of an XML doc
+`.fsdocs-example` | the 'example' section of an XML doc
+`.fsdocs-note` | the 'notes' section of an XML doc
+`.fsdocs-para` | a paragraph of an XML doc
+
+
+Some generated elements are given specific HTML ids:
+
+HTML element selector | Content
+:--- | :---
+`header` | The navigation-bar
+`#fsdocs-main-menu` | The main menu on the left side
+`#content` | The generated content
+`#fsdocs-page-menu` | The sub menu on the right side
+`dialog` | The search dialog
+`dialog input[type=search]` | The search box
+`#fsdocs-logo` | The logo
+
+
+If you write a new theme by CSS styling please contribute it back to FSharp.Formatting.
+
+## Customizing via a new template
+
+You can do advanced styling by creating a new template. Add a file `docs/_template.html`, likely starting
+with the existing default template.
+
+> NOTE: To enable hot reload during development with `fsdocs watch` in a custom `_template.html` file,
+make sure to add the single line `{{fsdocs-watch-script}}`  to your `` tag.
+NOTE: There is no guarantee that your template will continue to work with future versions of F# Formatting.
+If you do develop a good template please consider contributing it back to F# Formatting.
+> 
+
+## Customizing menu items by template
+
+You can add advanced styling to the sidebar generated menu items by creating a new template for it.
+`fsdoc` will look for menu templates in the `--input` folder, which defaults to the docs folder.
+
+To customize the generated menu-item headers, use file `_menu_template.html` with starting template:
+
+```html
+
                                                                                                                                                                                                                                                            • 
+    {{fsdocs-menu-header-content}}
+
                                                                                                                                                                                                                                                              • 
+{{fsdocs-menu-items}}
+```
+
+Similarly, to customize the individual menu item list, use file `_menu-item_template.html` with the starting template:
+
+```html
+
                                                                                                                                                                                                                                                            • {{fsdocs-menu-item-content}}
                                                                                                                                                                                                                                                              • 
+```
+
+Do note that files must be added before running, or won't be generated.
+In case you want to get a unique identifier for a header or menu item, you can use `{{fsdocs-menu-header-id}}`
+and `{{fsdocs-menu-item-id}}`, respectively.
+
+## Injecting additional html into the default template
+
+Occasionally, you may find the need to make small customizations to the default template, such as adding a Google
+Analytics snippet or including additional style or script tags. To address this scenario, you can create two
+files: `_head.html` and/or `_body.html`.
+
+The content within these files will serve as replacements for the `{{fsdocs-head-extra}}` and `{{fsdocs-body-extra}}`
+placeholders, which are utilized in the default template.
+
+## Customizing by generating your own site using your own code
+
+The `FSharp.Formatting.ApiDocs` namespace includes a `GenerateModel` that captures
+the results of documentation preparation in `ApiDocsModel` and allows you to
+generate your own site using your own code.
+
+> NOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site
+generation will continue to work
+with future versions of F# Formatting.
+NOTE: The `ApiDocsModel` currently includes some generated HTML with some specific style tags.
+In the long term these may be removed from the design of that component.
+> 
+
+
diff --git a/styling.tex b/styling.tex
new file mode 100644
index 000000000..f1e9c3cb9
--- /dev/null
+++ b/styling.tex
@@ -0,0 +1,302 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Customization and Styling}
+
+
+
+When using \texttt{fsdocs}, there are six levels of extra content development and styling.
+\begin{enumerate}
+\item 
+
+Don't do any styling or documentation customization and simply write content. This is by far the simplest option to
+maintain.
+
+\item 
+
+Add content such as an \texttt{docs/index.md} to customize the front-page content for your generated docs.
+You can also add content such as \texttt{docs/reference/fslib.md} to give a bespoke landing page
+for one of your namespaces, e.g. here assumed to be \texttt{namespace FsLib}. This will override any
+generated content.
+
+\item 
+
+Customize via Styling Parameters
+
+\item 
+
+Customize via CSS
+
+\item 
+
+Customize via a new template
+
+\item 
+
+Customize by generating your own site using your own code
+
+\end{enumerate}
+
+
+
+By default \texttt{fsdocs} does no styling customization and uses the following defaults. These are the settings used to build
+this site.
+\begin{itemize}
+\item 
+
+Uses the default template
+in \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/\_template.html}{docs/\_template.html}
+
+\item 
+
+Uses the default styles
+in \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css}{docs/content/fsdocs-default.css}.
+
+\item 
+
+Uses no custom styles
+in \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/content/fsdocs-default.css}{docs/content/fsdocs-custom.css}.
+
+\item 
+
+Uses no styling parameters except those extracted from the project files.
+
+\end{itemize}
+
+
+
+For your project, you don't need any of these files. However, you can add them if you wish, though if
+you adjust them there is no guarantee that your template will continue to work with future versions of F\# Formatting.
+\subsection*{Customizing via Styling Parameters}
+
+
+
+The following \href{content.html}{content parameters} are particularly related to visual styling:
+\begin{tabular}{|l|l|}\hline
+\textbf{Substitution name} & \textbf{Value (if not overriden by --parameters)}\\ \hline\hline
+\texttt{fsdocs-authors} & \texttt{}\\ \hline
+\texttt{fsdocs-license-link} & \texttt{}\\ \hline
+\texttt{fsdocs-logo-src} & \texttt{}\\ \hline
+\texttt{fsdocs-favicon-src} & \texttt{}\\ \hline
+\texttt{fsdocs-logo-link} & \texttt{}\\ \hline
+\texttt{fsdocs-release-notes-link} & \texttt{} else \texttt{/blob/master/RELEASE\_NOTES.md}\\ \hline
+\texttt{fsdocs-repository-link} & \texttt{}\\ \hline
+\texttt{fsdocs-theme} & \texttt{}, must currently be \texttt{default}\\ \hline
+\end{tabular}
+
+
+
+These basic entry-level styling parameters can be set in the project file or \texttt{Directory.Build.props}.
+For example:
+\begin{lstlisting}
+
+    
+    https://github.com/foo/bar/blob/master/License.txt
+    https://foo.github.io/bar/
+    https://github.com/foo/bar/
+    https://fsharp.org
+    img/logo.png
+    img/favicon.ico
+    https://github.com/foo/bar/blob/master/License.txt
+    https://github.com/foo/bar/blob/master/release-notes.md
+    true
+    default
+
+
+\end{lstlisting}
+
+
+As an example, here is \href{templates/leftside/styling.html}{a page with alternative styling}.
+\subsection*{Customizing via CSS}
+
+
+
+You can start styling by creating a file \texttt{docs/content/fsdocs-theme.css} and adding entries to it.
+
+It is loaded by the standard template.
+\subsubsection*{CSS variables}
+
+
+
+The default template is heavily based
+on \href{https://developer.mozilla.org/en-US/docs/Web/CSS/Using\_CSS\_custom\_properties}{CSS variables}. These can easily be
+override to customize the look and feel of the default theme.
+
+A full list of the overrideable variables can be
+found \href{https://github.com/fsprojects/FSharp.Formatting/blob/main/docs/content/fsdocs-default.css}{here}.
+\begin{lstlisting}
+:root {
+    --text-color: red;
+}
+
+[data-theme=dark] {
+    --text-color: darkred;
+}
+
+\end{lstlisting}
+
+
+Please be aware that the \texttt{dark} mode in the default theme is using the same variables.
+When you override a variable, it will also be used in \texttt{dark} mode unless redefined in a \texttt{[data-theme=dark]} CSS query.
+\subsubsection*{CSS classes}
+
+
+
+The API documentation uses a set of fixed CSS classes:
+\begin{tabular}{|l|l|}\hline
+\textbf{CSS class} & \textbf{Corresponding Content}\\ \hline\hline
+\texttt{.fsdocs-tip} & generated tooltips\\ \hline
+\texttt{.fsdocs-xmldoc} & generated xmldoc sections\\ \hline
+\texttt{.fsdocs-member-list} & generated member lists (tables)\\ \hline
+\texttt{.fsdocs-member-usage} & usage in generated member lists\\ \hline
+\texttt{.fsdocs-member-tooltip} & tooltips in generated member lists\\ \hline
+\texttt{.fsdocs-member-xmldoc} & documentation in generated member lists\\ \hline
+\texttt{.fsdocs-entity-list} & generated entity lists\\ \hline
+\texttt{.fsdocs-entity-name} & generated entity lists\\ \hline
+\texttt{.fsdocs-entity-xmldoc} & documentation in generated entity lists\\ \hline
+\texttt{.fsdocs-exception-list} & generated exception lists\\ \hline
+\texttt{.fsdocs-summary} & the 'summary' section of an XML doc\\ \hline
+\texttt{.fsdocs-remarks} & the 'remarks' section of an XML doc\\ \hline
+\texttt{.fsdocs-params} & the 'parameters' section of an XML doc\\ \hline
+\texttt{.fsdocs-param} & a 'parameter' section of an XML doc\\ \hline
+\texttt{.fsdocs-param-name} & a 'parameter' name of an XML doc\\ \hline
+\texttt{.fsdocs-returns} & the 'returns' section of an XML doc\\ \hline
+\texttt{.fsdocs-example} & the 'example' section of an XML doc\\ \hline
+\texttt{.fsdocs-note} & the 'notes' section of an XML doc\\ \hline
+\texttt{.fsdocs-para} & a paragraph of an XML doc\\ \hline
+\end{tabular}
+
+
+
+Some generated elements are given specific HTML ids:
+\begin{tabular}{|l|l|}\hline
+\textbf{HTML element selector} & \textbf{Content}\\ \hline\hline
+\texttt{header} & The navigation-bar\\ \hline
+\texttt{\#fsdocs-main-menu} & The main menu on the left side\\ \hline
+\texttt{\#content} & The generated content\\ \hline
+\texttt{\#fsdocs-page-menu} & The sub menu on the right side\\ \hline
+\texttt{dialog} & The search dialog\\ \hline
+\texttt{dialog input[type=search]} & The search box\\ \hline
+\texttt{\#fsdocs-logo} & The logo\\ \hline
+\end{tabular}
+
+
+
+If you write a new theme by CSS styling please contribute it back to FSharp.Formatting.
+\subsection*{Customizing via a new template}
+
+
+
+You can do advanced styling by creating a new template. Add a file \texttt{docs/\_template.html}, likely starting
+with the existing default template.
+\begin{quote}
+
+
+NOTE: To enable hot reload during development with \texttt{fsdocs watch} in a custom \texttt{\_template.html} file,
+make sure to add the single line \texttt{\{\{fsdocs-watch-script\}\}}  to your \texttt{} tag.
+NOTE: There is no guarantee that your template will continue to work with future versions of F\# Formatting.
+If you do develop a good template please consider contributing it back to F\# Formatting.
+\end{quote}
+
+\subsection*{Customizing menu items by template}
+
+
+
+You can add advanced styling to the sidebar generated menu items by creating a new template for it.
+\texttt{fsdoc} will look for menu templates in the \texttt{--input} folder, which defaults to the docs folder.
+
+
+To customize the generated menu-item headers, use file \texttt{\_menu\_template.html} with starting template:
+\begin{lstlisting}
+
                                                                                                                                                                                                                                                            • 
+    {{fsdocs-menu-header-content}}
+
                                                                                                                                                                                                                                                              • 
+{{fsdocs-menu-items}}
+
+\end{lstlisting}
+
+
+Similarly, to customize the individual menu item list, use file \texttt{\_menu-item\_template.html} with the starting template:
+\begin{lstlisting}
+
                                                                                                                                                                                                                                                            • {{fsdocs-menu-item-content}}
                                                                                                                                                                                                                                                              • 
+
+\end{lstlisting}
+
+
+Do note that files must be added before running, or won't be generated.
+In case you want to get a unique identifier for a header or menu item, you can use \texttt{\{\{fsdocs-menu-header-id\}\}}
+and \texttt{\{\{fsdocs-menu-item-id\}\}}, respectively.
+\subsection*{Injecting additional html into the default template}
+
+
+
+Occasionally, you may find the need to make small customizations to the default template, such as adding a Google
+Analytics snippet or including additional style or script tags. To address this scenario, you can create two
+files: \texttt{\_head.html} and/or \texttt{\_body.html}.
+
+
+The content within these files will serve as replacements for the \texttt{\{\{fsdocs-head-extra\}\}} and \texttt{\{\{fsdocs-body-extra\}\}}
+placeholders, which are utilized in the default template.
+\subsection*{Customizing by generating your own site using your own code}
+
+
+
+The \texttt{FSharp.Formatting.ApiDocs} namespace includes a \texttt{GenerateModel} that captures
+the results of documentation preparation in \texttt{ApiDocsModel} and allows you to
+generate your own site using your own code.
+\begin{quote}
+
+
+NOTE: The ApiDocsModel API is undergoing change and improvement, and there is no guarantee that your bespoke site
+generation will continue to work
+with future versions of F\# Formatting.
+NOTE: The \texttt{ApiDocsModel} currently includes some generated HTML with some specific style tags.
+In the long term these may be removed from the design of that component.
+\end{quote}
+
+
+
+\end{document}
\ No newline at end of file
diff --git a/templates/leftside/styling.fsx b/templates/leftside/styling.fsx
new file mode 100644
index 000000000..12a3abf2c
--- /dev/null
+++ b/templates/leftside/styling.fsx
@@ -0,0 +1,29 @@
+(**
+# Example: Styling for Right-Side Navigation Bar
+
+
+The sidebar can be moved to the right by overwriting the following CSS variables in your `fsdocs-theme.css` file:
+
+```css
+:root {
+    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);
+    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);
+    --main-menu-grid-column: 2;
+    --main-grid-column: 1;
+}
+```
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+
+*)
+
diff --git a/templates/leftside/styling.html b/templates/leftside/styling.html
new file mode 100644
index 000000000..f706580f1
--- /dev/null
+++ b/templates/leftside/styling.html
@@ -0,0 +1,343 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Example: Styling for Right-Side Navigation Bar
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                                              
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                                              
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                              
+    
                                                                                                                                                                                                                                                              
+        
+
                                                                                                                                                                                                                                                              Example: Styling for Right-Side Navigation Bar
                                                                                                                                                                                                                                                              
+
+
                                                                                                                                                                                                                                                              The sidebar can be moved to the right by overwriting the following CSS variables in your fsdocs-theme.css file:
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              :root {
+    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);
+    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);
+    --main-menu-grid-column: 2;
+    --main-grid-column: 1;
+}
+
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
                                                                                                                                                                                                                                                              
+
+        
+    
                                                                                                                                                                                                                                                              
+
                                                                                                                                                                                                                                                              
+
+
+    
+    
                                                                                                                                                                                                                                                              
+        
                                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                                Type something to start searching.
                                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                                
+                                                                                                                                                                                                                                                                
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/templates/leftside/styling.ipynb b/templates/leftside/styling.ipynb
new file mode 100644
index 000000000..bd1bfa720
--- /dev/null
+++ b/templates/leftside/styling.ipynb
@@ -0,0 +1,89 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Example: Styling for Right-Side Navigation Bar\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "\u003cstyle\u003e\n",
+    ":root {\n",
+    "    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);\n",
+    "    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);\n",
+    "    --main-menu-grid-column: 2;\n",
+    "    --main-grid-column: 1;\n",
+    "}\n",
+    "\u003c/style\u003e\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "The sidebar can be moved to the right by overwriting the following CSS variables in your `fsdocs-theme.css` file:\n",
+    "\n",
+    "```css\n",
+    ":root {\n",
+    "    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);\n",
+    "    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);\n",
+    "    --main-menu-grid-column: 2;\n",
+    "    --main-grid-column: 1;\n",
+    "}\n",
+    "```\n",
+    "\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n",
+    "\n",
+    "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/templates/leftside/styling.md b/templates/leftside/styling.md
new file mode 100644
index 000000000..1ce33ed9c
--- /dev/null
+++ b/templates/leftside/styling.md
@@ -0,0 +1,27 @@
+# Example: Styling for Right-Side Navigation Bar
+
+
+The sidebar can be moved to the right by overwriting the following CSS variables in your `fsdocs-theme.css` file:
+
+```css
+:root {
+    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);
+    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);
+    --main-menu-grid-column: 2;
+    --main-grid-column: 1;
+}
+```
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+
+
diff --git a/templates/leftside/styling.tex b/templates/leftside/styling.tex
new file mode 100644
index 000000000..2f5f87e72
--- /dev/null
+++ b/templates/leftside/styling.tex
@@ -0,0 +1,77 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Example: Styling for Right-Side Navigation Bar}
+
+
+
+
+The sidebar can be moved to the right by overwriting the following CSS variables in your \texttt{fsdocs-theme.css} file:
+\begin{lstlisting}
+:root {
+    --body-grid-template-columns: minmax(0, 1fr) var(--main-menu-width);
+    --body-grid-template-columns-xl: minmax(0, 1fr) var(--main-menu-width) var(--page-menu-width);
+    --main-menu-grid-column: 2;
+    --main-grid-column: 1;
+}
+
+\end{lstlisting}
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+
+
+\end{document}
\ No newline at end of file
diff --git a/upgrade.fsx b/upgrade.fsx
new file mode 100644
index 000000000..b4c39b0a1
--- /dev/null
+++ b/upgrade.fsx
@@ -0,0 +1,83 @@
+(**
+# Upgrading to fsdocs
+
+Here are the typical steps to upgrade a repo based on `ProjectScaffold` to use `fsdocs`
+
+0 Run
+  
+
+      [lang=text]
+      dotnet new tool
+      dotnet tool install fsdocs-tool
+  
+
+1 Delete all of `docs\tools` particularly `docs\tool\generate.fsx`.  Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.
+  
+
+2 Put your docs directory so it reflects the final shape of the site. For example move the content of `docs\input\*` and `docs\files\*` directly to `docs\*`
+  
+
+3 Follow the notes in [styling](styling.html) to start to style your site.
+  
+
+4 Run
+  
+
+      [lang=text]
+      dotnet fsdocs watch
+  
+
+  and edit and test your docs.
+  
+
+5 If using FAKE adjust `build.fsx` e.g.
+  
+
+      [lang=text]
+      Target.create "GenerateDocs" (fun _ ->
+         Shell.cleanDir ".fsdocs"
+         DotNet.exec id "fsdocs" "build --clean" |> ignore
+      )
+      
+      Target.create "ReleaseDocs" (fun _ ->
+          Git.Repository.clone "" projectRepo "temp/gh-pages"
+          Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
+          Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
+          Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
+          let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
+          Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+          Git.Branches.push "temp/gh-pages"
+      )
+  
+
+6 Consider creating `docs\_template.fsx` and `docs\_template.ipynb` to enable co-generation of F# scripts and F# notebooks.
+  
+
+  If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L19).
+  
+
+  Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo.  For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L1).
+  
+
+Sample commands:
+
+    [lang=text]
+    dotnet tool install fsdocs-tool --local
+    git add dotnet-tools.json   
+    git rm -fr docs/tools
+    git mv docs/input/* docs
+    git mv docs/files/* docs
+    
+    
+
+    dotnet fsdocs watch
+
+    touch docs/_template.fsx
+    touch docs/_template.ipynb
+    git add docs/_template.fsx
+    git add docs/_template.ipynb
+
+Here is an example PR: [https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116](https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116)
+
+*)
+
diff --git a/upgrade.html b/upgrade.html
new file mode 100644
index 000000000..bf10ba7a7
--- /dev/null
+++ b/upgrade.html
@@ -0,0 +1,383 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Upgrading to fsdocs
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                                
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                                
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                
+
+
                                                                                                                                                                                                                                                                
+    
                                                                                                                                                                                                                                                                
+        
+
                                                                                                                                                                                                                                                                Upgrading to fsdocs
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                Here are the typical steps to upgrade a repo based on ProjectScaffold to use fsdocs
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                1. 
+
                                                                                                                                                                                                                                                                  Run
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  dotnet new tool
+dotnet tool install fsdocs-tool
+
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  2. 
+
                                                                                                                                                                                                                                                                2. Delete all of docs\tools particularly docs\tool\generate.fsx.  Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.
                                                                                                                                                                                                                                                                  3. 
+
                                                                                                                                                                                                                                                                3. Put your docs directory so it reflects the final shape of the site. For example move the content of docs\input\* and docs\files\* directly to docs\*
                                                                                                                                                                                                                                                                  4. 
+
                                                                                                                                                                                                                                                                4. Follow the notes in styling to start to style your site.
                                                                                                                                                                                                                                                                  5. 
+
                                                                                                                                                                                                                                                                5. 
+
                                                                                                                                                                                                                                                                  Run
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  dotnet fsdocs watch
+
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  and edit and test your docs.
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  6. 
+
                                                                                                                                                                                                                                                                6. 
+
                                                                                                                                                                                                                                                                  If using FAKE adjust build.fsx e.g.
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  Target.create "GenerateDocs" (fun _ ->
+   Shell.cleanDir ".fsdocs"
+   DotNet.exec id "fsdocs" "build --clean" |> ignore
+)
+
+Target.create "ReleaseDocs" (fun _ ->
+    Git.Repository.clone "" projectRepo "temp/gh-pages"
+    Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
+    Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
+    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
+    let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
+    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+    Git.Branches.push "temp/gh-pages"
+)
+
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  7. 
+
                                                                                                                                                                                                                                                                7. 
+
                                                                                                                                                                                                                                                                  Consider creating docs\_template.fsx and docs\_template.ipynb to enable co-generation of F# scripts and F# notebooks.
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example like this.
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo.  For example like this.
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  8. 
+
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                Sample commands:
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                dotnet tool install fsdocs-tool --local
+git add dotnet-tools.json   
+git rm -fr docs/tools
+git mv docs/input/* docs
+git mv docs/files/* docs
+
+<manually download and fixup the _template.html>
+
+dotnet fsdocs watch
+
+touch docs/_template.fsx
+touch docs/_template.ipynb
+git add docs/_template.fsx
+git add docs/_template.ipynb
+
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                Here is an example PR: https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116
                                                                                                                                                                                                                                                                
+
+        
+    
                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                
+
+
+    
+    
                                                                                                                                                                                                                                                                
+        
                                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                                  Type something to start searching.
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/upgrade.ipynb b/upgrade.ipynb
new file mode 100644
index 000000000..2c33d8be5
--- /dev/null
+++ b/upgrade.ipynb
@@ -0,0 +1,120 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Upgrading to fsdocs\n",
+    "\n",
+    "Here are the typical steps to upgrade a repo based on `ProjectScaffold` to use `fsdocs`\n",
+    "\n",
+    "0 Run\n",
+    "  \n",
+    "\n",
+    "      [lang=text]\n",
+    "      dotnet new tool\n",
+    "      dotnet tool install fsdocs-tool\n",
+    "  \n",
+    "\n",
+    "1 Delete all of `docs\\tools` particularly `docs\\tool\\generate.fsx`.  Keep a copy of any templates for reference as you\u0027ll have to copy some bits across to the new template.\n",
+    "  \n",
+    "\n",
+    "2 Put your docs directory so it reflects the final shape of the site. For example move the content of `docs\\input\\*` and `docs\\files\\*` directly to `docs\\*`\n",
+    "  \n",
+    "\n",
+    "3 Follow the notes in [styling](styling.html) to start to style your site.\n",
+    "  \n",
+    "\n",
+    "4 Run\n",
+    "  \n",
+    "\n",
+    "      [lang=text]\n",
+    "      dotnet fsdocs watch\n",
+    "  \n",
+    "\n",
+    "  and edit and test your docs.\n",
+    "  \n",
+    "\n",
+    "5 If using FAKE adjust `build.fsx` e.g.\n",
+    "  \n",
+    "\n",
+    "      [lang=text]\n",
+    "      Target.create \"GenerateDocs\" (fun _ -\u003e\n",
+    "         Shell.cleanDir \".fsdocs\"\n",
+    "         DotNet.exec id \"fsdocs\" \"build --clean\" |\u003e ignore\n",
+    "      )\n",
+    "      \n",
+    "      Target.create \"ReleaseDocs\" (fun _ -\u003e\n",
+    "          Git.Repository.clone \"\" projectRepo \"temp/gh-pages\"\n",
+    "          Git.Branches.checkoutBranch \"temp/gh-pages\" \"gh-pages\"\n",
+    "          Shell.copyRecursive \"output\" \"temp/gh-pages\" true |\u003e printfn \"%A\"\n",
+    "          Git.CommandHelper.runSimpleGitCommand \"temp/gh-pages\" \"add .\" |\u003e printfn \"%s\"\n",
+    "          let cmd = sprintf \"\"\"commit -a -m \"Update generated documentation for version %s\"\"\" release.NugetVersion\n",
+    "          Git.CommandHelper.runSimpleGitCommand \"temp/gh-pages\" cmd |\u003e printfn \"%s\"\n",
+    "          Git.Branches.push \"temp/gh-pages\"\n",
+    "      )\n",
+    "  \n",
+    "\n",
+    "6 Consider creating `docs\\_template.fsx` and `docs\\_template.ipynb` to enable co-generation of F# scripts and F# notebooks.\n",
+    "  \n",
+    "\n",
+    "  If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L19).\n",
+    "  \n",
+    "\n",
+    "  Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo.  For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L1).\n",
+    "  \n",
+    "\n",
+    "Sample commands:\n",
+    "\n",
+    "    [lang=text]\n",
+    "    dotnet tool install fsdocs-tool --local\n",
+    "    git add dotnet-tools.json   \n",
+    "    git rm -fr docs/tools\n",
+    "    git mv docs/input/* docs\n",
+    "    git mv docs/files/* docs\n",
+    "    \n",
+    "    \u003cmanually download and fixup the _template.html\u003e\n",
+    "\n",
+    "    dotnet fsdocs watch\n",
+    "\n",
+    "    touch docs/_template.fsx\n",
+    "    touch docs/_template.ipynb\n",
+    "    git add docs/_template.fsx\n",
+    "    git add docs/_template.ipynb\n",
+    "\n",
+    "Here is an example PR: [https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116](https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116)\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/upgrade.md b/upgrade.md
new file mode 100644
index 000000000..bc67fb405
--- /dev/null
+++ b/upgrade.md
@@ -0,0 +1,81 @@
+# Upgrading to fsdocs
+
+Here are the typical steps to upgrade a repo based on `ProjectScaffold` to use `fsdocs`
+
+0 Run
+  
+
+      [lang=text]
+      dotnet new tool
+      dotnet tool install fsdocs-tool
+  
+
+1 Delete all of `docs\tools` particularly `docs\tool\generate.fsx`.  Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.
+  
+
+2 Put your docs directory so it reflects the final shape of the site. For example move the content of `docs\input\*` and `docs\files\*` directly to `docs\*`
+  
+
+3 Follow the notes in [styling](styling.html) to start to style your site.
+  
+
+4 Run
+  
+
+      [lang=text]
+      dotnet fsdocs watch
+  
+
+  and edit and test your docs.
+  
+
+5 If using FAKE adjust `build.fsx` e.g.
+  
+
+      [lang=text]
+      Target.create "GenerateDocs" (fun _ ->
+         Shell.cleanDir ".fsdocs"
+         DotNet.exec id "fsdocs" "build --clean" |> ignore
+      )
+      
+      Target.create "ReleaseDocs" (fun _ ->
+          Git.Repository.clone "" projectRepo "temp/gh-pages"
+          Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
+          Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
+          Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
+          let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
+          Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+          Git.Branches.push "temp/gh-pages"
+      )
+  
+
+6 Consider creating `docs\_template.fsx` and `docs\_template.ipynb` to enable co-generation of F# scripts and F# notebooks.
+  
+
+  If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L19).
+  
+
+  Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo.  For example [like this](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx#L1).
+  
+
+Sample commands:
+
+    [lang=text]
+    dotnet tool install fsdocs-tool --local
+    git add dotnet-tools.json   
+    git rm -fr docs/tools
+    git mv docs/input/* docs
+    git mv docs/files/* docs
+    
+    
+
+    dotnet fsdocs watch
+
+    touch docs/_template.fsx
+    touch docs/_template.ipynb
+    git add docs/_template.fsx
+    git add docs/_template.ipynb
+
+Here is an example PR: [https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116](https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116)
+
+
diff --git a/upgrade.tex b/upgrade.tex
new file mode 100644
index 000000000..c9a6b452b
--- /dev/null
+++ b/upgrade.tex
@@ -0,0 +1,143 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Upgrading to fsdocs}
+
+
+
+Here are the typical steps to upgrade a repo based on \texttt{ProjectScaffold} to use \texttt{fsdocs}
+\begin{enumerate}
+\item 
+
+Run
+\begin{lstlisting}
+dotnet new tool
+dotnet tool install fsdocs-tool
+
+\end{lstlisting}
+
+\item 
+
+Delete all of \texttt{docs{\textbackslash}tools} particularly \texttt{docs{\textbackslash}tool{\textbackslash}generate.fsx}.  Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.
+
+\item 
+
+Put your docs directory so it reflects the final shape of the site. For example move the content of \texttt{docs{\textbackslash}input{\textbackslash}*} and \texttt{docs{\textbackslash}files{\textbackslash}*} directly to \texttt{docs{\textbackslash}*}
+
+\item 
+
+Follow the notes in \href{styling.html}{styling} to start to style your site.
+
+\item 
+
+Run
+\begin{lstlisting}
+dotnet fsdocs watch
+
+\end{lstlisting}
+
+
+and edit and test your docs.
+
+\item 
+
+If using FAKE adjust \texttt{build.fsx} e.g.
+\begin{lstlisting}
+Target.create "GenerateDocs" (fun _ ->
+   Shell.cleanDir ".fsdocs"
+   DotNet.exec id "fsdocs" "build --clean" |> ignore
+)
+
+Target.create "ReleaseDocs" (fun _ ->
+    Git.Repository.clone "" projectRepo "temp/gh-pages"
+    Git.Branches.checkoutBranch "temp/gh-pages" "gh-pages"
+    Shell.copyRecursive "output" "temp/gh-pages" true |> printfn "%A"
+    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" "add ." |> printfn "%s"
+    let cmd = sprintf """commit -a -m "Update generated documentation for version %s""" release.NugetVersion
+    Git.CommandHelper.runSimpleGitCommand "temp/gh-pages" cmd |> printfn "%s"
+    Git.Branches.push "temp/gh-pages"
+)
+
+\end{lstlisting}
+
+\item 
+
+Consider creating \texttt{docs{\textbackslash}\_template.fsx} and \texttt{docs{\textbackslash}\_template.ipynb} to enable co-generation of F\# scripts and F\# notebooks.
+
+
+If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx\#L19}{like this}.
+
+
+Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo.  For example \href{https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/literate.fsx\#L1}{like this}.
+
+\end{enumerate}
+
+
+
+Sample commands:
+\begin{lstlisting}
+dotnet tool install fsdocs-tool --local
+git add dotnet-tools.json   
+git rm -fr docs/tools
+git mv docs/input/* docs
+git mv docs/files/* docs
+
+
+
+dotnet fsdocs watch
+
+touch docs/_template.fsx
+touch docs/_template.ipynb
+git add docs/_template.fsx
+git add docs/_template.ipynb
+
+\end{lstlisting}
+
+
+Here is an example PR: \href{https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116}{https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116}
+
+
+\end{document}
\ No newline at end of file
diff --git a/users.fsx b/users.fsx
new file mode 100644
index 000000000..89878175a
--- /dev/null
+++ b/users.fsx
@@ -0,0 +1,35 @@
+(**
+# Users of FSharp.Formatting
+
+The FSharp.Formatting documentation tool is widely used within the F# community.
+Here is a non-exhaustive list of projects:
+
+
+
+Project name | Repository | Note
+--- | :--- | --- | ---
+[FSharp.Formatting](https://fsprojects.github.io/FSharp.Formatting/) |   | [[https://github.com/fsprojects/FSharp.Formatting/](https://github.com/fsprojects/FSharp.Formatting/)](https://github.com/fsprojects/FSharp.Formatting/) |  
+[F# compiler guide](https://fsharp.github.io/fsharp-compiler-docs/) |   | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-compiler-docs](https://github.com/fsharp/fsharp-compiler-docs)](https://github.com/fsharp/fsharp-compiler-docs)
+[F# Core Library Documentation](https://fsharp.github.io/fsharp-core-docs/) |   | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-core-docs](https://github.com/fsharp/fsharp-core-docs)](https://github.com/fsharp/fsharp-core-docs)
+[FsLexYacc](https://fsprojects.github.io/FsLexYacc) |   | [[https://github.com/fsprojects/fslexYacc/](https://github.com/fsprojects/fslexYacc/)](https://github.com/fsprojects/fslexYacc/) |  
+[FSharp.Data](https://fsprojects.github.io/FSharp.Data/) |   | [[https://github.com/fsprojects/FSharp.Data/](https://github.com/fsprojects/FSharp.Data/)](https://github.com/fsprojects/FSharp.Data/) |  
+[Plotly.NET](https://plotly.net/) |   | [[https://github.com/plotly/Plotly.NET](https://github.com/plotly/Plotly.NET)](https://github.com/plotly/Plotly.NET) |  
+[FSharp.Stats](https://fslab.org/FSharp.Stats/) |   | [[https://github.com/fslaborg/FSharp.Stats/](https://github.com/fslaborg/FSharp.Stats/)](https://github.com/fslaborg/FSharp.Stats/) |  
+[FsHttp](https://fsprojects.github.io/FsHttp/) |   | [[https://github.com/fsprojects/FsHttp/](https://github.com/fsprojects/FsHttp/)](https://github.com/fsprojects/FsHttp/) |  
+[Fantomas](https://fsprojects.github.io/fantomas/docs/) |   | [[https://github.com/fsprojects/fantomas/](https://github.com/fsprojects/fantomas/)](https://github.com/fsprojects/fantomas/) |  
+[Telplin](https://nojaf.com/telplin/docs/) |   | [[https://github.com/nojaf/telplin/](https://github.com/nojaf/telplin/)](https://github.com/nojaf/telplin/) |  
+[FSharp.Data.Fred](https://github.com/nhirschey/FSharp.Data.Fred/) |   | [[https://github.com/nhirschey/FSharp.Data.Fred/](https://github.com/nhirschey/FSharp.Data.Fred/)](https://github.com/nhirschey/FSharp.Data.Fred/) |  
+[N Hirschey Teaching](https://nhirschey.github.io/Teaching/) |   | [[https://github.com/nhirschey/Teaching](https://github.com/nhirschey/Teaching)](https://github.com/nhirschey/Teaching) |  
+[FsUnit](https://fsprojects.github.io/FsUnit/) |   | [[https://github.com/fsprojects/FsUnit](https://github.com/fsprojects/FsUnit)](https://github.com/fsprojects/FsUnit) |  
+[FAKE](https://fake.build/) |   | [[https://github.com/fsprojects/FAKE](https://github.com/fsprojects/FAKE)](https://github.com/fsprojects/FAKE) |  
+[FSharp.Data.GraphQL](https://fsprojects.github.io/FSharp.Data.GraphQL/) |   | [[https://github.com/fsprojects/FSharp.Data.GraphQL](https://github.com/fsprojects/FSharp.Data.GraphQL)](https://github.com/fsprojects/FSharp.Data.GraphQL) |  
+
+
+*)
+
diff --git a/users.html b/users.html
new file mode 100644
index 000000000..3a2c5dab5
--- /dev/null
+++ b/users.html
@@ -0,0 +1,438 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Users of FSharp.Formatting
+ | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  
+
+
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+        
+
                                                                                                                                                                                                                                                                  Users of FSharp.Formatting
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  The FSharp.Formatting documentation tool is widely used within the F# community.
                                                                                                                                                                                                                                                                  
+Here is a non-exhaustive list of projects:
                                                                                                                                                                                                                                                                  
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                                                                                                                                                                                                                                  Project name
                                                                                                                                                                                                                                                                  Repository
                                                                                                                                                                                                                                                                  Note
                                                                                                                                                                                                                                                                  FSharp.Formatting
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FSharp.Formatting/
                                                                                                                                                                                                                                                                  F# compiler guide
                                                                                                                                                                                                                                                                  https://github.com/dotnet/fsharp/
                                                                                                                                                                                                                                                                  The documentation is generated and published from https://github.com/fsharp/fsharp-compiler-docs
                                                                                                                                                                                                                                                                  F# Core Library Documentation
                                                                                                                                                                                                                                                                  https://github.com/dotnet/fsharp/
                                                                                                                                                                                                                                                                  The documentation is generated and published from https://github.com/fsharp/fsharp-core-docs
                                                                                                                                                                                                                                                                  FsLexYacc
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/fslexYacc/
                                                                                                                                                                                                                                                                  FSharp.Data
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FSharp.Data/
                                                                                                                                                                                                                                                                  Plotly.NET
                                                                                                                                                                                                                                                                  https://github.com/plotly/Plotly.NET
                                                                                                                                                                                                                                                                  FSharp.Stats
                                                                                                                                                                                                                                                                  https://github.com/fslaborg/FSharp.Stats/
                                                                                                                                                                                                                                                                  FsHttp
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FsHttp/
                                                                                                                                                                                                                                                                  Fantomas
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/fantomas/
                                                                                                                                                                                                                                                                  Telplin
                                                                                                                                                                                                                                                                  https://github.com/nojaf/telplin/
                                                                                                                                                                                                                                                                  FSharp.Data.Fred
                                                                                                                                                                                                                                                                  https://github.com/nhirschey/FSharp.Data.Fred/
                                                                                                                                                                                                                                                                  N Hirschey Teaching
                                                                                                                                                                                                                                                                  https://github.com/nhirschey/Teaching
                                                                                                                                                                                                                                                                  FsUnit
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FsUnit
                                                                                                                                                                                                                                                                  FAKE
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FAKE
                                                                                                                                                                                                                                                                  FSharp.Data.GraphQL
                                                                                                                                                                                                                                                                  https://github.com/fsprojects/FSharp.Data.GraphQL
                                                                                                                                                                                                                                                                  
+
+
+        
+    
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  
+
+
+    
+    
                                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                                                    Type something to start searching.
                                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                                    
+                                                                                                                                                                                                                                                                    
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/users.ipynb b/users.ipynb
new file mode 100644
index 000000000..2fc3eeae8
--- /dev/null
+++ b/users.ipynb
@@ -0,0 +1,95 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Users of FSharp.Formatting\n",
+    "\n",
+    "The FSharp.Formatting documentation tool is widely used within the F# community.\n",
+    "Here is a non-exhaustive list of projects:\n",
+    "\n"
+   ]
+  }
+,
+  {
+   "cell_type": "code",
+   "metadata": {
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "execution_count": null, "outputs": [],
+   "source": [
+    "\u003c!-- temporary --\u003e\n",
+    "\u003cstyle\u003e\n",
+    "table { table-layout: fixed; }\n",
+    "tr td { padding: 15px 0; }\n",
+    "tr td p { margin: 0 }\n",
+    "tr th:first-child, tr td:first-child { width: 20%; }\n",
+    "tr th:last-child, tr td:last-child { width: 35% }\n",
+    "\u003c/style\u003e\n"
+   ]
+  }
+,
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "Project name | Repository | Note\n",
+    "--- | :--- | --- | ---\n",
+    "[FSharp.Formatting](https://fsprojects.github.io/FSharp.Formatting/) | \u0026#32; | [[https://github.com/fsprojects/FSharp.Formatting/](https://github.com/fsprojects/FSharp.Formatting/)](https://github.com/fsprojects/FSharp.Formatting/) | \u0026#32;\n",
+    "[F# compiler guide](https://fsharp.github.io/fsharp-compiler-docs/) | \u0026#32; | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-compiler-docs](https://github.com/fsharp/fsharp-compiler-docs)](https://github.com/fsharp/fsharp-compiler-docs)\n",
+    "[F# Core Library Documentation](https://fsharp.github.io/fsharp-core-docs/) | \u0026#32; | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-core-docs](https://github.com/fsharp/fsharp-core-docs)](https://github.com/fsharp/fsharp-core-docs)\n",
+    "[FsLexYacc](https://fsprojects.github.io/FsLexYacc) | \u0026#32; | [[https://github.com/fsprojects/fslexYacc/](https://github.com/fsprojects/fslexYacc/)](https://github.com/fsprojects/fslexYacc/) | \u0026#32;\n",
+    "[FSharp.Data](https://fsprojects.github.io/FSharp.Data/) | \u0026#32; | [[https://github.com/fsprojects/FSharp.Data/](https://github.com/fsprojects/FSharp.Data/)](https://github.com/fsprojects/FSharp.Data/) | \u0026#32;\n",
+    "[Plotly.NET](https://plotly.net/) | \u0026#32; | [[https://github.com/plotly/Plotly.NET](https://github.com/plotly/Plotly.NET)](https://github.com/plotly/Plotly.NET) | \u0026#32;\n",
+    "[FSharp.Stats](https://fslab.org/FSharp.Stats/) | \u0026#32; | [[https://github.com/fslaborg/FSharp.Stats/](https://github.com/fslaborg/FSharp.Stats/)](https://github.com/fslaborg/FSharp.Stats/) | \u0026#32;\n",
+    "[FsHttp](https://fsprojects.github.io/FsHttp/) | \u0026#32; | [[https://github.com/fsprojects/FsHttp/](https://github.com/fsprojects/FsHttp/)](https://github.com/fsprojects/FsHttp/) | \u0026#32;\n",
+    "[Fantomas](https://fsprojects.github.io/fantomas/docs/) | \u0026#32; | [[https://github.com/fsprojects/fantomas/](https://github.com/fsprojects/fantomas/)](https://github.com/fsprojects/fantomas/) | \u0026#32;\n",
+    "[Telplin](https://nojaf.com/telplin/docs/) | \u0026#32; | [[https://github.com/nojaf/telplin/](https://github.com/nojaf/telplin/)](https://github.com/nojaf/telplin/) | \u0026#32;\n",
+    "[FSharp.Data.Fred](https://github.com/nhirschey/FSharp.Data.Fred/) | \u0026#32; | [[https://github.com/nhirschey/FSharp.Data.Fred/](https://github.com/nhirschey/FSharp.Data.Fred/)](https://github.com/nhirschey/FSharp.Data.Fred/) | \u0026#32;\n",
+    "[N Hirschey Teaching](https://nhirschey.github.io/Teaching/) | \u0026#32; | [[https://github.com/nhirschey/Teaching](https://github.com/nhirschey/Teaching)](https://github.com/nhirschey/Teaching) | \u0026#32;\n",
+    "[FsUnit](https://fsprojects.github.io/FsUnit/) | \u0026#32; | [[https://github.com/fsprojects/FsUnit](https://github.com/fsprojects/FsUnit)](https://github.com/fsprojects/FsUnit) | \u0026#32;\n",
+    "[FAKE](https://fake.build/) | \u0026#32; | [[https://github.com/fsprojects/FAKE](https://github.com/fsprojects/FAKE)](https://github.com/fsprojects/FAKE) | \u0026#32;\n",
+    "[FSharp.Data.GraphQL](https://fsprojects.github.io/FSharp.Data.GraphQL/) | \u0026#32; | [[https://github.com/fsprojects/FSharp.Data.GraphQL](https://github.com/fsprojects/FSharp.Data.GraphQL)](https://github.com/fsprojects/FSharp.Data.GraphQL) | \u0026#32;\n",
+    "\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/users.md b/users.md
new file mode 100644
index 000000000..3217b49fe
--- /dev/null
+++ b/users.md
@@ -0,0 +1,33 @@
+# Users of FSharp.Formatting
+
+The FSharp.Formatting documentation tool is widely used within the F# community.
+Here is a non-exhaustive list of projects:
+
+
+
+Project name | Repository | Note
+--- | :--- | --- | ---
+[FSharp.Formatting](https://fsprojects.github.io/FSharp.Formatting/) |   | [[https://github.com/fsprojects/FSharp.Formatting/](https://github.com/fsprojects/FSharp.Formatting/)](https://github.com/fsprojects/FSharp.Formatting/) |  
+[F# compiler guide](https://fsharp.github.io/fsharp-compiler-docs/) |   | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-compiler-docs](https://github.com/fsharp/fsharp-compiler-docs)](https://github.com/fsharp/fsharp-compiler-docs)
+[F# Core Library Documentation](https://fsharp.github.io/fsharp-core-docs/) |   | [[https://github.com/dotnet/fsharp/](https://github.com/dotnet/fsharp/)](https://github.com/dotnet/fsharp/) | The documentation is generated and published from [[https://github.com/fsharp/fsharp-core-docs](https://github.com/fsharp/fsharp-core-docs)](https://github.com/fsharp/fsharp-core-docs)
+[FsLexYacc](https://fsprojects.github.io/FsLexYacc) |   | [[https://github.com/fsprojects/fslexYacc/](https://github.com/fsprojects/fslexYacc/)](https://github.com/fsprojects/fslexYacc/) |  
+[FSharp.Data](https://fsprojects.github.io/FSharp.Data/) |   | [[https://github.com/fsprojects/FSharp.Data/](https://github.com/fsprojects/FSharp.Data/)](https://github.com/fsprojects/FSharp.Data/) |  
+[Plotly.NET](https://plotly.net/) |   | [[https://github.com/plotly/Plotly.NET](https://github.com/plotly/Plotly.NET)](https://github.com/plotly/Plotly.NET) |  
+[FSharp.Stats](https://fslab.org/FSharp.Stats/) |   | [[https://github.com/fslaborg/FSharp.Stats/](https://github.com/fslaborg/FSharp.Stats/)](https://github.com/fslaborg/FSharp.Stats/) |  
+[FsHttp](https://fsprojects.github.io/FsHttp/) |   | [[https://github.com/fsprojects/FsHttp/](https://github.com/fsprojects/FsHttp/)](https://github.com/fsprojects/FsHttp/) |  
+[Fantomas](https://fsprojects.github.io/fantomas/docs/) |   | [[https://github.com/fsprojects/fantomas/](https://github.com/fsprojects/fantomas/)](https://github.com/fsprojects/fantomas/) |  
+[Telplin](https://nojaf.com/telplin/docs/) |   | [[https://github.com/nojaf/telplin/](https://github.com/nojaf/telplin/)](https://github.com/nojaf/telplin/) |  
+[FSharp.Data.Fred](https://github.com/nhirschey/FSharp.Data.Fred/) |   | [[https://github.com/nhirschey/FSharp.Data.Fred/](https://github.com/nhirschey/FSharp.Data.Fred/)](https://github.com/nhirschey/FSharp.Data.Fred/) |  
+[N Hirschey Teaching](https://nhirschey.github.io/Teaching/) |   | [[https://github.com/nhirschey/Teaching](https://github.com/nhirschey/Teaching)](https://github.com/nhirschey/Teaching) |  
+[FsUnit](https://fsprojects.github.io/FsUnit/) |   | [[https://github.com/fsprojects/FsUnit](https://github.com/fsprojects/FsUnit)](https://github.com/fsprojects/FsUnit) |  
+[FAKE](https://fake.build/) |   | [[https://github.com/fsprojects/FAKE](https://github.com/fsprojects/FAKE)](https://github.com/fsprojects/FAKE) |  
+[FSharp.Data.GraphQL](https://fsprojects.github.io/FSharp.Data.GraphQL/) |   | [[https://github.com/fsprojects/FSharp.Data.GraphQL](https://github.com/fsprojects/FSharp.Data.GraphQL)](https://github.com/fsprojects/FSharp.Data.GraphQL) |  
+
+
+
diff --git a/users.tex b/users.tex
new file mode 100644
index 000000000..28a83b880
--- /dev/null
+++ b/users.tex
@@ -0,0 +1,83 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Users of FSharp.Formatting}
+
+
+
+The FSharp.Formatting documentation tool is widely used within the F\# community.
+
+Here is a non-exhaustive list of projects:
+
+
+\begin{tabular}{|l|l|l|l|}\hline
+\textbf{Project name} & \textbf{} & \textbf{Repository} & \textbf{Note}\\ \hline\hline
+\href{https://fsprojects.github.io/FSharp.Formatting/}{FSharp.Formatting} &  & \href{https://github.com/fsprojects/FSharp.Formatting/}{\href{https://github.com/fsprojects/FSharp.Formatting/}{https://github.com/fsprojects/FSharp.Formatting/}} & \\ \hline
+\href{https://fsharp.github.io/fsharp-compiler-docs/}{F\# compiler guide} &  & \href{https://github.com/dotnet/fsharp/}{\href{https://github.com/dotnet/fsharp/}{https://github.com/dotnet/fsharp/}} & The documentation is generated and published from \href{https://github.com/fsharp/fsharp-compiler-docs}{\href{https://github.com/fsharp/fsharp-compiler-docs}{https://github.com/fsharp/fsharp-compiler-docs}}\\ \hline
+\href{https://fsharp.github.io/fsharp-core-docs/}{F\# Core Library Documentation} &  & \href{https://github.com/dotnet/fsharp/}{\href{https://github.com/dotnet/fsharp/}{https://github.com/dotnet/fsharp/}} & The documentation is generated and published from \href{https://github.com/fsharp/fsharp-core-docs}{\href{https://github.com/fsharp/fsharp-core-docs}{https://github.com/fsharp/fsharp-core-docs}}\\ \hline
+\href{https://fsprojects.github.io/FsLexYacc}{FsLexYacc} &  & \href{https://github.com/fsprojects/fslexYacc/}{\href{https://github.com/fsprojects/fslexYacc/}{https://github.com/fsprojects/fslexYacc/}} & \\ \hline
+\href{https://fsprojects.github.io/FSharp.Data/}{FSharp.Data} &  & \href{https://github.com/fsprojects/FSharp.Data/}{\href{https://github.com/fsprojects/FSharp.Data/}{https://github.com/fsprojects/FSharp.Data/}} & \\ \hline
+\href{https://plotly.net/}{Plotly.NET} &  & \href{https://github.com/plotly/Plotly.NET}{\href{https://github.com/plotly/Plotly.NET}{https://github.com/plotly/Plotly.NET}} & \\ \hline
+\href{https://fslab.org/FSharp.Stats/}{FSharp.Stats} &  & \href{https://github.com/fslaborg/FSharp.Stats/}{\href{https://github.com/fslaborg/FSharp.Stats/}{https://github.com/fslaborg/FSharp.Stats/}} & \\ \hline
+\href{https://fsprojects.github.io/FsHttp/}{FsHttp} &  & \href{https://github.com/fsprojects/FsHttp/}{\href{https://github.com/fsprojects/FsHttp/}{https://github.com/fsprojects/FsHttp/}} & \\ \hline
+\href{https://fsprojects.github.io/fantomas/docs/}{Fantomas} &  & \href{https://github.com/fsprojects/fantomas/}{\href{https://github.com/fsprojects/fantomas/}{https://github.com/fsprojects/fantomas/}} & \\ \hline
+\href{https://nojaf.com/telplin/docs/}{Telplin} &  & \href{https://github.com/nojaf/telplin/}{\href{https://github.com/nojaf/telplin/}{https://github.com/nojaf/telplin/}} & \\ \hline
+\href{https://github.com/nhirschey/FSharp.Data.Fred/}{FSharp.Data.Fred} &  & \href{https://github.com/nhirschey/FSharp.Data.Fred/}{\href{https://github.com/nhirschey/FSharp.Data.Fred/}{https://github.com/nhirschey/FSharp.Data.Fred/}} & \\ \hline
+\href{https://nhirschey.github.io/Teaching/}{N Hirschey Teaching} &  & \href{https://github.com/nhirschey/Teaching}{\href{https://github.com/nhirschey/Teaching}{https://github.com/nhirschey/Teaching}} & \\ \hline
+\href{https://fsprojects.github.io/FsUnit/}{FsUnit} &  & \href{https://github.com/fsprojects/FsUnit}{\href{https://github.com/fsprojects/FsUnit}{https://github.com/fsprojects/FsUnit}} & \\ \hline
+\href{https://fake.build/}{FAKE} &  & \href{https://github.com/fsprojects/FAKE}{\href{https://github.com/fsprojects/FAKE}{https://github.com/fsprojects/FAKE}} & \\ \hline
+\href{https://fsprojects.github.io/FSharp.Data.GraphQL/}{FSharp.Data.GraphQL} &  & \href{https://github.com/fsprojects/FSharp.Data.GraphQL}{\href{https://github.com/fsprojects/FSharp.Data.GraphQL}{https://github.com/fsprojects/FSharp.Data.GraphQL}} & \\ \hline
+\end{tabular}
+
+
+
+\end{document}
\ No newline at end of file
diff --git a/zero-to-hero.fsx b/zero-to-hero.fsx
new file mode 100644
index 000000000..88926e68e
--- /dev/null
+++ b/zero-to-hero.fsx
@@ -0,0 +1,267 @@
+(**
+# 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/).
+
+## Install the local tool
+
+If you don't have a [dotnet tool manifest](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#create-a-manifest-file), you can create one using `dotnet new tool-manifest`.
+
+Next, we can install [fsdocs-tool](https://www.nuget.org/packages/fsdocs-tool/) using `dotnet tool install --local fsdocs-tool`.
+It is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.
+
+## Create the docs folder
+
+After we've installed the tool, we can run `dotnet fsdocs --help` and see the available commands.
+Both `build` and `watch` will generate the documentation for a solution and an input folder.
+The default folder for `--input` is the `./docs` folder, relative to the current working directory.
+
+Typically, your project will be structured like this:
+
+```
+/repository-root
+  YourSolution.sln
+  ./docs
+    index.md
+    other-file.md
+  ./src
+    ./Project1/Project1.fsproj
+    ./Project2/Project2.fsproj
+```
+
+It is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.
+When users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.
+
+⚠️ Please avoid putting your solution in the `src` folder. When we open that solution, it can be more difficult to edit files in the `docs` folder, as we can sometimes only see the `src` folder.
+
+That being said, let's create the `docs` folder and a first Markdown file named `index.md`.
+When `fsdocs` runs, it will transform this `index.md` file to `index.html`, which will be served at the root.
+
+We can put `# Hello world` in the markdown file for now.
+
+Having this in place, should already serve the first page when we start the `watch` command:
+
+> dotnet fsdocs watch
+> 
+
+Open [[http://localhost:8901](http://localhost:8901)](http://localhost:8901) and you should see our first page!
+
+🪄 You might notice that there are some images missing. You can add these in the `docs` folder in the right location.
+
+## Generating API documentation
+
+By default, `fsdocs` will generate API documentation for the configured `--projects`.
+When this flag is not specified, `fsdocs` will look for solutions or projects in the working directory.
+It will filter these found projects, the requirements are:
+
+* Having `library`
+
+* Having a binary, so you need to build your project first before the documentation can be generated.
+
+* Not having `true`
+
+* Having `true`
+
+🪄 If you made some changes in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
+
+## Adding the missing properties
+
+After our initial `watch` run, you may have noticed that some links aren't working yet.
+`License`, `Releases Notes` and `Source Repository` can be provided by setting MSBuild properties.
+
+You can either add these properties to a single `.fsproj` file, or more typically, add them to a [Directory.Build.props](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory) file.
+The simplest `Directory.Build.props` file:
+
+```xml
+
+    
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+        https://fsprojects.github.io/FSharp.AWS.DynamoDB
+    
+
+```
+
+🪄 If you don't have any release notes yet, you could consider using [Ionide.KeepAChangelog](https://github.com/ionide/KeepAChangelog).
+
+Running `dotnet fsdocs watch` will now yield:
+
+```
+  root --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+  ...
+  fsdocs-license-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+  fsdocs-release-notes-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+  ...
+  fsdocs-repository-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+```
+
+⚠️ Again, you might need to remove `.fsdocs/cache` in order for changes to be picked up!
+
+`` is actually a very important property when you run `dotnet fsdocs build`.
+`build` will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
+
+Pages will host your files from [https://github.com/user/project](https://github.com/user/project) on `https://user.github.io/project/` by default.
+You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
+
+Let's now run `dotnet fsdocs build`.
+
+`` will replace the `{{root}}` substitution, which is used all over the place in the default template.
+
+⚠️ You want to ensure that the static files in the `output` folder (after running the build) have the correct links.
+
+## Ignore generated files
+
+Alright, at this point we've made a lot of progress. If you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
+
+```.ignorelang
+# FSharp.Formatting
+.fsdocs/
+output/
+tmp/
+```
+
+## Ship it!
+
+Once we are satisfied with our documentation, we want to publish it to GitHub Pages.
+We can use [GitHub Actions](https://github.com/features/actions) to deploy our website.
+
+Deploy to Pages from GitHub Actions must be enabled in the repository settings:
+
+![Enable deploy from Actions](./content/img/github-pages-settings.png)
+
+The typical flow is to publish your documentation after a release or after new commits were added to the default branch.
+Let's create a very basic Action that will deploy our website after pushing to the main:
+
+Create a file `.github/workflows/docs.yml`:
+
+```yml
+name: Docs
+
+# Trigger this Action when new code is pushed to the main branch
+on:
+  push:
+    branches:
+      - main
+
+# We need some permissions to publish to Github Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the source code
+      - uses: actions/checkout@v4
+      # Setup dotnet, please use a global.json to ensure the right SDK is used!
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+      # Restore the local tools
+      - name: Restore tools
+        run: dotnet tool restore
+      # Build the code for the API documentation
+      - name: Build code
+        run: dotnet build -c Release YourSolution.sln
+      # Generate the documentation files
+      - name: Generate the documentation'
+        run: dotnet fsdocs build --properties Configuration=Release
+      # Upload the static files
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./output
+  
+  # GitHub Actions recommends deploying in a separate job.
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+```
+
+⚠️ Careful yaml is indentation sensitive!
+
+## Next steps
+
+Mission accomplished, right? If everything went well, you should have a published website at this point!
+Here are some next steps you could consider:
+
+### Use fsx file in your documentation
+
+Create documentation using [Literate Scripts](../literate.html). A typical flow here is that you load your locate project binary into a script and create examples using the latest code:
+
+```fsharp
+#r "../src/Project1/bin/Debug/net6.0/Project1.dll"
+
+open Project1
+
+// Actual consumption of your project!
+let result = SomeType.SomeMethod("foo")
+```
+
+When using the `--strict` flag in `dotnet fsdocs build`, your documentation generation will fail if your script contains errors.
+This is useful to ensure your documentation is always in sync with your latest public API!
+
+### Automatically update to newer versions of fsdocs-tool
+
+Using [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates) you can easily receive new PR's with updates to your `dotnet` dependencies.
+
+Create a `.github/dependabot.yml` file with:
+
+```yml
+version: 2
+updates:
+  # Update to newer version of GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Update to newer NuGet dependencies
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+```
+
+This will automatically create a new PR when there is an update to the `fsdocs` tool.
+
+⚠️ P️lease be very careful, if you have followed along, we don't have any GitHub Actions right now that run against pull requests!
+It is recommended to have an Action that builds your documentation against any incoming changes.
+You typically want to lint code, run unit tests and perform other useful checks as well!
+
+Example Action, `.github/workflows/ci.yml`:
+
+```yml
+name: CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v3
+    - name: Restore tools
+      run: dotnet tool restore
+    - name: Build
+      run: dotnet build YourSolution.sln
+    - name: Documentation
+      run: dotnet fsdocs build
+```
+
+⚠️ Also, never trust any update to `fsdocs` blindly, always check the [release notes](https://github.com/fsprojects/FSharp.Formatting/blob/main/RELEASE_NOTES.md) to see if there are any breaking changes.
+
+*)
+
diff --git a/zero-to-hero.html b/zero-to-hero.html
new file mode 100644
index 000000000..66dc512ce
--- /dev/null
+++ b/zero-to-hero.html
@@ -0,0 +1,566 @@
+
+
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    Getting Started | FSharp.Formatting
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+
+
+
                                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                                    
+        
+        
+            Header menu logo
+            FSharp.Formatting
+        
+    
                                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                                    
+        
+            
+        
+        
+        
+    
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    
+
+
                                                                                                                                                                                                                                                                    
+    
                                                                                                                                                                                                                                                                    
+        
+
                                                                                                                                                                                                                                                                    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.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Install the local tool
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    If you don't have a dotnet tool manifest, you can create one using dotnet new tool-manifest.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Next, we can install fsdocs-tool using dotnet tool install --local fsdocs-tool.
                                                                                                                                                                                                                                                                    
+It is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Create the docs folder
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    After we've installed the tool, we can run dotnet fsdocs --help and see the available commands.
                                                                                                                                                                                                                                                                    
+Both build and watch will generate the documentation for a solution and an input folder.
                                                                                                                                                                                                                                                                    
+The default folder for --input is the ./docs folder, relative to the current working directory.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Typically, your project will be structured like this:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    /repository-root
+  YourSolution.sln
+  ./docs
+    index.md
+    other-file.md
+  ./src
+    ./Project1/Project1.fsproj
+    ./Project2/Project2.fsproj
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    It is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.
                                                                                                                                                                                                                                                                    
+When users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ Please avoid putting your solution in the src folder. When we open that solution, it can be more difficult to edit files in the docs folder, as we can sometimes only see the src folder.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    That being said, let's create the docs folder and a first Markdown file named index.md.
                                                                                                                                                                                                                                                                    
+When fsdocs runs, it will transform this index.md file to index.html, which will be served at the root.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    We can put # Hello world in the markdown file for now.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Having this in place, should already serve the first page when we start the watch command:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    dotnet fsdocs watch
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Open http://localhost:8901 and you should see our first page!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    🪄 You might notice that there are some images missing. You can add these in the docs folder in the right location.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Generating API documentation
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    By default, fsdocs will generate API documentation for the configured --projects.
                                                                                                                                                                                                                                                                    
+When this flag is not specified, fsdocs will look for solutions or projects in the working directory.
                                                                                                                                                                                                                                                                    
+It will filter these found projects, the requirements are:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                      
+
                                                                                                                                                                                                                                                                    • Having <OutputType>library</OutputType>
                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                    • Having a binary, so you need to build your project first before the documentation can be generated.
                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                    • Not having <IsTestProject>true</IsTestProject>
                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                    • Having <GenerateDocumentationFile>true</GenerateDocumentationFile>
                                                                                                                                                                                                                                                                      • 
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    🪄 If you made some changes in order to adhere to the rules, you may want to remove the .fsdocs/cache file.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Adding the missing properties
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    After our initial watch run, you may have noticed that some links aren't working yet.
                                                                                                                                                                                                                                                                    
+License, Releases Notes and Source Repository can be provided by setting MSBuild properties.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    You can either add these properties to a single .fsproj file, or more typically, add them to a Directory.Build.props file.
                                                                                                                                                                                                                                                                    
+The simplest Directory.Build.props file:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    <Project>
+    <PropertyGroup>
+        <RepositoryUrl>https://github.com/fsprojects/FSharp.AWS.DynamoDB</RepositoryUrl>
+        <FsDocsLicenseLink>https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md</FsDocsLicenseLink>
+        <FsDocsReleaseNotesLink>https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
+        <PackageProjectUrl>https://fsprojects.github.io/FSharp.AWS.DynamoDB</PackageProjectUrl>
+    </PropertyGroup>
+</Project>
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    🪄 If you don't have any release notes yet, you could consider using Ionide.KeepAChangelog.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Running dotnet fsdocs watch will now yield:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                      root --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+  ...
+  fsdocs-license-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+  fsdocs-release-notes-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+  ...
+  fsdocs-repository-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ Again, you might need to remove .fsdocs/cache in order for changes to be picked up!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    <PackageProjectUrl> is actually a very important property when you run dotnet fsdocs build.
                                                                                                                                                                                                                                                                    
+build will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Pages will host your files from https://github.com/user/project on https://user.github.io/project/ by default.
                                                                                                                                                                                                                                                                    
+You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Let's now run dotnet fsdocs build.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    <PackageProjectUrl> will replace the {{root}} substitution, which is used all over the place in the default template.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ You want to ensure that the static files in the output folder (after running the build) have the correct links.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Ignore generated files
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Alright, at this point we've made a lot of progress. If you are using git you want to add the following to your .gitignore file.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    # FSharp.Formatting
+.fsdocs/
+output/
+tmp/
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Ship it!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Once we are satisfied with our documentation, we want to publish it to GitHub Pages.
+We can use GitHub Actions to deploy our website.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Deploy to Pages from GitHub Actions must be enabled in the repository settings:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Enable deploy from Actions
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    The typical flow is to publish your documentation after a release or after new commits were added to the default branch.
                                                                                                                                                                                                                                                                    
+Let's create a very basic Action that will deploy our website after pushing to the main:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Create a file .github/workflows/docs.yml:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    name: Docs
+
+# Trigger this Action when new code is pushed to the main branch
+on:
+  push:
+    branches:
+      - main
+
+# We need some permissions to publish to Github Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the source code
+      - uses: actions/checkout@v4
+      # Setup dotnet, please use a global.json to ensure the right SDK is used!
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+      # Restore the local tools
+      - name: Restore tools
+        run: dotnet tool restore
+      # Build the code for the API documentation
+      - name: Build code
+        run: dotnet build -c Release YourSolution.sln
+      # Generate the documentation files
+      - name: Generate the documentation'
+        run: dotnet fsdocs build --properties Configuration=Release
+      # Upload the static files
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./output
+  
+  # GitHub Actions recommends deploying in a separate job.
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ Careful yaml is indentation sensitive!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Next steps
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Mission accomplished, right? If everything went well, you should have a published website at this point!
                                                                                                                                                                                                                                                                    
+Here are some next steps you could consider:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Use fsx file in your documentation
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Create documentation using Literate Scripts. A typical flow here is that you load your locate project binary into a script and create examples using the latest code:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    #r "../src/Project1/bin/Debug/net6.0/Project1.dll"
+
+open Project1
+
+// Actual consumption of your project!
+let result = SomeType.SomeMethod("foo")
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    When using the --strict flag in dotnet fsdocs build, your documentation generation will fail if your script contains errors.
                                                                                                                                                                                                                                                                    
+This is useful to ensure your documentation is always in sync with your latest public API!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Automatically update to newer versions of fsdocs-tool
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Using Dependabot you can easily receive new PR's with updates to your dotnet dependencies.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Create a .github/dependabot.yml file with:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    version: 2
+updates:
+  # Update to newer version of GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Update to newer NuGet dependencies
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    This will automatically create a new PR when there is an update to the fsdocs tool.
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ P️lease be very careful, if you have followed along, we don't have any GitHub Actions right now that run against pull requests!
                                                                                                                                                                                                                                                                    
+It is recommended to have an Action that builds your documentation against any incoming changes.
                                                                                                                                                                                                                                                                    
+You typically want to lint code, run unit tests and perform other useful checks as well!
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    Example Action, .github/workflows/ci.yml:
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    name: CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v3
+    - name: Restore tools
+      run: dotnet tool restore
+    - name: Build
+      run: dotnet build YourSolution.sln
+    - name: Documentation
+      run: dotnet fsdocs build
+
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    ⚠️ Also, never trust any update to fsdocs blindly, always check the release notes to see if there are any breaking changes.
                                                                                                                                                                                                                                                                    
+
+        
+    
                                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                                    
+
+
+    
+    
                                                                                                                                                                                                                                                                    
+        
                                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                                      Type something to start searching.
                                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                                      
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/zero-to-hero.ipynb b/zero-to-hero.ipynb
new file mode 100644
index 000000000..20e1b8549
--- /dev/null
+++ b/zero-to-hero.ipynb
@@ -0,0 +1,304 @@
+
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   
+   "source": [
+    "# Getting Started\n",
+    "\n",
+    "## From zero to hero: deploying to GitHub Pages\n",
+    "\n",
+    "This guide is meant for a typical setup of open-source projects on GitHub.\n",
+    "We start from a repository without any documentation and aim to end up with a published website on [GitHub Pages](https://pages.github.com/).\n",
+    "\n",
+    "## Install the local tool\n",
+    "\n",
+    "If you don\u0027t have a [dotnet tool manifest](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#create-a-manifest-file), you can create one using `dotnet new tool-manifest`.\n",
+    "\n",
+    "Next, we can install [fsdocs-tool](https://www.nuget.org/packages/fsdocs-tool/) using `dotnet tool install --local fsdocs-tool`.\n",
+    "It is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.\n",
+    "\n",
+    "## Create the docs folder\n",
+    "\n",
+    "After we\u0027ve installed the tool, we can run `dotnet fsdocs --help` and see the available commands.\n",
+    "Both `build` and `watch` will generate the documentation for a solution and an input folder.\n",
+    "The default folder for `--input` is the `./docs` folder, relative to the current working directory.\n",
+    "\n",
+    "Typically, your project will be structured like this:\n",
+    "\n",
+    "```\n",
+    "/repository-root\n",
+    "  YourSolution.sln\n",
+    "  ./docs\n",
+    "    index.md\n",
+    "    other-file.md\n",
+    "  ./src\n",
+    "    ./Project1/Project1.fsproj\n",
+    "    ./Project2/Project2.fsproj\n",
+    "```\n",
+    "\n",
+    "It is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.\n",
+    "When users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.\n",
+    "\n",
+    "⚠️ Please avoid putting your solution in the `src` folder. When we open that solution, it can be more difficult to edit files in the `docs` folder, as we can sometimes only see the `src` folder.\n",
+    "\n",
+    "That being said, let\u0027s create the `docs` folder and a first Markdown file named `index.md`.\n",
+    "When `fsdocs` runs, it will transform this `index.md` file to `index.html`, which will be served at the root.\n",
+    "\n",
+    "We can put `# Hello world` in the markdown file for now.\n",
+    "\n",
+    "Having this in place, should already serve the first page when we start the `watch` command:\n",
+    "\n",
+    "\u003e dotnet fsdocs watch\n",
+    "\u003e \n",
+    "\n",
+    "Open [[http://localhost:8901](http://localhost:8901)](http://localhost:8901) and you should see our first page!\n",
+    "\n",
+    "🪄 You might notice that there are some images missing. You can add these in the `docs` folder in the right location.\n",
+    "\n",
+    "## Generating API documentation\n",
+    "\n",
+    "By default, `fsdocs` will generate API documentation for the configured `--projects`.\n",
+    "When this flag is not specified, `fsdocs` will look for solutions or projects in the working directory.\n",
+    "It will filter these found projects, the requirements are:\n",
+    "\n",
+    "* Having `\u003cOutputType\u003elibrary\u003c/OutputType\u003e`\n",
+    "\n",
+    "* Having a binary, so you need to build your project first before the documentation can be generated.\n",
+    "\n",
+    "* Not having `\u003cIsTestProject\u003etrue\u003c/IsTestProject\u003e`\n",
+    "\n",
+    "* Having `\u003cGenerateDocumentationFile\u003etrue\u003c/GenerateDocumentationFile\u003e`\n",
+    "\n",
+    "🪄 If you made some changes in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.\n",
+    "\n",
+    "## Adding the missing properties\n",
+    "\n",
+    "After our initial `watch` run, you may have noticed that some links aren\u0027t working yet.\n",
+    "`License`, `Releases Notes` and `Source Repository` can be provided by setting MSBuild properties.\n",
+    "\n",
+    "You can either add these properties to a single `.fsproj` file, or more typically, add them to a [Directory.Build.props](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory) file.\n",
+    "The simplest `Directory.Build.props` file:\n",
+    "\n",
+    "```xml\n",
+    "\u003cProject\u003e\n",
+    "    \u003cPropertyGroup\u003e\n",
+    "        \u003cRepositoryUrl\u003ehttps://github.com/fsprojects/FSharp.AWS.DynamoDB\u003c/RepositoryUrl\u003e\n",
+    "        \u003cFsDocsLicenseLink\u003ehttps://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md\u003c/FsDocsLicenseLink\u003e\n",
+    "        \u003cFsDocsReleaseNotesLink\u003ehttps://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md\u003c/FsDocsReleaseNotesLink\u003e\n",
+    "        \u003cPackageProjectUrl\u003ehttps://fsprojects.github.io/FSharp.AWS.DynamoDB\u003c/PackageProjectUrl\u003e\n",
+    "    \u003c/PropertyGroup\u003e\n",
+    "\u003c/Project\u003e\n",
+    "```\n",
+    "\n",
+    "🪄 If you don\u0027t have any release notes yet, you could consider using [Ionide.KeepAChangelog](https://github.com/ionide/KeepAChangelog).\n",
+    "\n",
+    "Running `dotnet fsdocs watch` will now yield:\n",
+    "\n",
+    "```\n",
+    "  root --\u003e https://github.com/fsprojects/FSharp.AWS.DynamoDB/\n",
+    "  ...\n",
+    "  fsdocs-license-link --\u003e https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md\n",
+    "  fsdocs-release-notes-link --\u003e https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md\n",
+    "  ...\n",
+    "  fsdocs-repository-link --\u003e https://github.com/fsprojects/FSharp.AWS.DynamoDB/\n",
+    "```\n",
+    "\n",
+    "⚠️ Again, you might need to remove `.fsdocs/cache` in order for changes to be picked up!\n",
+    "\n",
+    "`\u003cPackageProjectUrl\u003e` is actually a very important property when you run `dotnet fsdocs build`.\n",
+    "`build` will generate static files for the targeted production environment. In our case, this will be GitHub Pages.\n",
+    "\n",
+    "Pages will host your files from [https://github.com/user/project](https://github.com/user/project) on `https://user.github.io/project/` by default.\n",
+    "You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.\n",
+    "\n",
+    "Let\u0027s now run `dotnet fsdocs build`.\n",
+    "\n",
+    "`\u003cPackageProjectUrl\u003e` will replace the `{{root}}` substitution, which is used all over the place in the default template.\n",
+    "\n",
+    "⚠️ You want to ensure that the static files in the `output` folder (after running the build) have the correct links.\n",
+    "\n",
+    "## Ignore generated files\n",
+    "\n",
+    "Alright, at this point we\u0027ve made a lot of progress. If you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.\n",
+    "\n",
+    "```.ignorelang\n",
+    "# FSharp.Formatting\n",
+    ".fsdocs/\n",
+    "output/\n",
+    "tmp/\n",
+    "```\n",
+    "\n",
+    "## Ship it!\n",
+    "\n",
+    "Once we are satisfied with our documentation, we want to publish it to GitHub Pages.\n",
+    "We can use [GitHub Actions](https://github.com/features/actions) to deploy our website.\n",
+    "\n",
+    "Deploy to Pages from GitHub Actions must be enabled in the repository settings:\n",
+    "\n",
+    "![Enable deploy from Actions](./content/img/github-pages-settings.png)\n",
+    "\n",
+    "The typical flow is to publish your documentation after a release or after new commits were added to the default branch.\n",
+    "Let\u0027s create a very basic Action that will deploy our website after pushing to the main:\n",
+    "\n",
+    "Create a file `.github/workflows/docs.yml`:\n",
+    "\n",
+    "```yml\n",
+    "name: Docs\n",
+    "\n",
+    "# Trigger this Action when new code is pushed to the main branch\n",
+    "on:\n",
+    "  push:\n",
+    "    branches:\n",
+    "      - main\n",
+    "\n",
+    "# We need some permissions to publish to Github Pages\n",
+    "permissions:\n",
+    "  contents: write\n",
+    "  pages: write\n",
+    "  id-token: write\n",
+    "\n",
+    "jobs:\n",
+    "  build:\n",
+    "    runs-on: ubuntu-latest\n",
+    "    steps:\n",
+    "      # Checkout the source code\n",
+    "      - uses: actions/checkout@v4\n",
+    "      # Setup dotnet, please use a global.json to ensure the right SDK is used!\n",
+    "      - name: Setup .NET\n",
+    "        uses: actions/setup-dotnet@v3\n",
+    "      # Restore the local tools\n",
+    "      - name: Restore tools\n",
+    "        run: dotnet tool restore\n",
+    "      # Build the code for the API documentation\n",
+    "      - name: Build code\n",
+    "        run: dotnet build -c Release YourSolution.sln\n",
+    "      # Generate the documentation files\n",
+    "      - name: Generate the documentation\u0027\n",
+    "        run: dotnet fsdocs build --properties Configuration=Release\n",
+    "      # Upload the static files\n",
+    "      - name: Upload documentation\n",
+    "        uses: actions/upload-pages-artifact@v2\n",
+    "        with:\n",
+    "          path: ./output\n",
+    "  \n",
+    "  # GitHub Actions recommends deploying in a separate job.\n",
+    "  deploy:\n",
+    "    runs-on: ubuntu-latest\n",
+    "    needs: build\n",
+    "    steps:\n",
+    "      - name: Deploy to GitHub Pages\n",
+    "        id: deployment\n",
+    "        uses: actions/deploy-pages@v2\n",
+    "```\n",
+    "\n",
+    "⚠️ Careful yaml is indentation sensitive!\n",
+    "\n",
+    "## Next steps\n",
+    "\n",
+    "Mission accomplished, right? If everything went well, you should have a published website at this point!\n",
+    "Here are some next steps you could consider:\n",
+    "\n",
+    "### Use fsx file in your documentation\n",
+    "\n",
+    "Create documentation using [Literate Scripts](../literate.html). A typical flow here is that you load your locate project binary into a script and create examples using the latest code:\n",
+    "\n",
+    "```fsharp\n",
+    "#r \"../src/Project1/bin/Debug/net6.0/Project1.dll\"\n",
+    "\n",
+    "open Project1\n",
+    "\n",
+    "// Actual consumption of your project!\n",
+    "let result = SomeType.SomeMethod(\"foo\")\n",
+    "```\n",
+    "\n",
+    "When using the `--strict` flag in `dotnet fsdocs build`, your documentation generation will fail if your script contains errors.\n",
+    "This is useful to ensure your documentation is always in sync with your latest public API!\n",
+    "\n",
+    "### Automatically update to newer versions of fsdocs-tool\n",
+    "\n",
+    "Using [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates) you can easily receive new PR\u0027s with updates to your `dotnet` dependencies.\n",
+    "\n",
+    "Create a `.github/dependabot.yml` file with:\n",
+    "\n",
+    "```yml\n",
+    "version: 2\n",
+    "updates:\n",
+    "  # Update to newer version of GitHub Actions\n",
+    "  - package-ecosystem: \"github-actions\"\n",
+    "    directory: \"/\"\n",
+    "    schedule:\n",
+    "      interval: \"weekly\"\n",
+    "\n",
+    "  # Update to newer NuGet dependencies\n",
+    "  - package-ecosystem: \"nuget\"\n",
+    "    directory: \"/\"\n",
+    "    schedule:\n",
+    "      interval: \"daily\"\n",
+    "```\n",
+    "\n",
+    "This will automatically create a new PR when there is an update to the `fsdocs` tool.\n",
+    "\n",
+    "⚠️ P️lease be very careful, if you have followed along, we don\u0027t have any GitHub Actions right now that run against pull requests!\n",
+    "It is recommended to have an Action that builds your documentation against any incoming changes.\n",
+    "You typically want to lint code, run unit tests and perform other useful checks as well!\n",
+    "\n",
+    "Example Action, `.github/workflows/ci.yml`:\n",
+    "\n",
+    "```yml\n",
+    "name: CI\n",
+    "\n",
+    "on: [pull_request]\n",
+    "\n",
+    "jobs:\n",
+    "  build:\n",
+    "    runs-on: ubuntu-latest\n",
+    "\n",
+    "    steps:\n",
+    "    - uses: actions/checkout@v3\n",
+    "    - name: Setup .NET Core\n",
+    "      uses: actions/setup-dotnet@v3\n",
+    "    - name: Restore tools\n",
+    "      run: dotnet tool restore\n",
+    "    - name: Build\n",
+    "      run: dotnet build YourSolution.sln\n",
+    "    - name: Documentation\n",
+    "      run: dotnet fsdocs build\n",
+    "```\n",
+    "\n",
+    "⚠️ Also, never trust any update to `fsdocs` blindly, always check the [release notes](https://github.com/fsprojects/FSharp.Formatting/blob/main/RELEASE_NOTES.md) to see if there are any breaking changes.\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "polyglot-notebook",
+   "pygments_lexer": "fsharp"
+  },
+  "polyglot_notebook": {
+   "kernelInfo": {
+    "defaultKernelName": "fsharp",
+    "items": [
+     {
+      "aliases": [],
+      "languageName": "fsharp",
+      "name": "fsharp"
+     }
+    ]
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
+
diff --git a/zero-to-hero.md b/zero-to-hero.md
new file mode 100644
index 000000000..201cde532
--- /dev/null
+++ b/zero-to-hero.md
@@ -0,0 +1,265 @@
+# 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/).
+
+## Install the local tool
+
+If you don't have a [dotnet tool manifest](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#create-a-manifest-file), you can create one using `dotnet new tool-manifest`.
+
+Next, we can install [fsdocs-tool](https://www.nuget.org/packages/fsdocs-tool/) using `dotnet tool install --local fsdocs-tool`.
+It is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.
+
+## Create the docs folder
+
+After we've installed the tool, we can run `dotnet fsdocs --help` and see the available commands.
+Both `build` and `watch` will generate the documentation for a solution and an input folder.
+The default folder for `--input` is the `./docs` folder, relative to the current working directory.
+
+Typically, your project will be structured like this:
+
+```
+/repository-root
+  YourSolution.sln
+  ./docs
+    index.md
+    other-file.md
+  ./src
+    ./Project1/Project1.fsproj
+    ./Project2/Project2.fsproj
+```
+
+It is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.
+When users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.
+
+⚠️ Please avoid putting your solution in the `src` folder. When we open that solution, it can be more difficult to edit files in the `docs` folder, as we can sometimes only see the `src` folder.
+
+That being said, let's create the `docs` folder and a first Markdown file named `index.md`.
+When `fsdocs` runs, it will transform this `index.md` file to `index.html`, which will be served at the root.
+
+We can put `# Hello world` in the markdown file for now.
+
+Having this in place, should already serve the first page when we start the `watch` command:
+
+> dotnet fsdocs watch
+> 
+
+Open [[http://localhost:8901](http://localhost:8901)](http://localhost:8901) and you should see our first page!
+
+🪄 You might notice that there are some images missing. You can add these in the `docs` folder in the right location.
+
+## Generating API documentation
+
+By default, `fsdocs` will generate API documentation for the configured `--projects`.
+When this flag is not specified, `fsdocs` will look for solutions or projects in the working directory.
+It will filter these found projects, the requirements are:
+
+* Having `library`
+
+* Having a binary, so you need to build your project first before the documentation can be generated.
+
+* Not having `true`
+
+* Having `true`
+
+🪄 If you made some changes in order to adhere to the rules, you may want to remove the `.fsdocs/cache` file.
+
+## Adding the missing properties
+
+After our initial `watch` run, you may have noticed that some links aren't working yet.
+`License`, `Releases Notes` and `Source Repository` can be provided by setting MSBuild properties.
+
+You can either add these properties to a single `.fsproj` file, or more typically, add them to a [Directory.Build.props](https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory) file.
+The simplest `Directory.Build.props` file:
+
+```xml
+
+    
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+        https://fsprojects.github.io/FSharp.AWS.DynamoDB
+    
+
+```
+
+🪄 If you don't have any release notes yet, you could consider using [Ionide.KeepAChangelog](https://github.com/ionide/KeepAChangelog).
+
+Running `dotnet fsdocs watch` will now yield:
+
+```
+  root --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+  ...
+  fsdocs-license-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+  fsdocs-release-notes-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+  ...
+  fsdocs-repository-link --> https://github.com/fsprojects/FSharp.AWS.DynamoDB/
+```
+
+⚠️ Again, you might need to remove `.fsdocs/cache` in order for changes to be picked up!
+
+`` is actually a very important property when you run `dotnet fsdocs build`.
+`build` will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
+
+Pages will host your files from [https://github.com/user/project](https://github.com/user/project) on `https://user.github.io/project/` by default.
+You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
+
+Let's now run `dotnet fsdocs build`.
+
+`` will replace the `{{root}}` substitution, which is used all over the place in the default template.
+
+⚠️ You want to ensure that the static files in the `output` folder (after running the build) have the correct links.
+
+## Ignore generated files
+
+Alright, at this point we've made a lot of progress. If you are using `git` you want to add the following to your [.gitignore](https://git-scm.com/docs/gitignore) file.
+
+```.ignorelang
+# FSharp.Formatting
+.fsdocs/
+output/
+tmp/
+```
+
+## Ship it!
+
+Once we are satisfied with our documentation, we want to publish it to GitHub Pages.
+We can use [GitHub Actions](https://github.com/features/actions) to deploy our website.
+
+Deploy to Pages from GitHub Actions must be enabled in the repository settings:
+
+![Enable deploy from Actions](./content/img/github-pages-settings.png)
+
+The typical flow is to publish your documentation after a release or after new commits were added to the default branch.
+Let's create a very basic Action that will deploy our website after pushing to the main:
+
+Create a file `.github/workflows/docs.yml`:
+
+```yml
+name: Docs
+
+# Trigger this Action when new code is pushed to the main branch
+on:
+  push:
+    branches:
+      - main
+
+# We need some permissions to publish to Github Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the source code
+      - uses: actions/checkout@v4
+      # Setup dotnet, please use a global.json to ensure the right SDK is used!
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+      # Restore the local tools
+      - name: Restore tools
+        run: dotnet tool restore
+      # Build the code for the API documentation
+      - name: Build code
+        run: dotnet build -c Release YourSolution.sln
+      # Generate the documentation files
+      - name: Generate the documentation'
+        run: dotnet fsdocs build --properties Configuration=Release
+      # Upload the static files
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./output
+  
+  # GitHub Actions recommends deploying in a separate job.
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+```
+
+⚠️ Careful yaml is indentation sensitive!
+
+## Next steps
+
+Mission accomplished, right? If everything went well, you should have a published website at this point!
+Here are some next steps you could consider:
+
+### Use fsx file in your documentation
+
+Create documentation using [Literate Scripts](../literate.html). A typical flow here is that you load your locate project binary into a script and create examples using the latest code:
+
+```fsharp
+#r "../src/Project1/bin/Debug/net6.0/Project1.dll"
+
+open Project1
+
+// Actual consumption of your project!
+let result = SomeType.SomeMethod("foo")
+```
+
+When using the `--strict` flag in `dotnet fsdocs build`, your documentation generation will fail if your script contains errors.
+This is useful to ensure your documentation is always in sync with your latest public API!
+
+### Automatically update to newer versions of fsdocs-tool
+
+Using [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates) you can easily receive new PR's with updates to your `dotnet` dependencies.
+
+Create a `.github/dependabot.yml` file with:
+
+```yml
+version: 2
+updates:
+  # Update to newer version of GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Update to newer NuGet dependencies
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+```
+
+This will automatically create a new PR when there is an update to the `fsdocs` tool.
+
+⚠️ P️lease be very careful, if you have followed along, we don't have any GitHub Actions right now that run against pull requests!
+It is recommended to have an Action that builds your documentation against any incoming changes.
+You typically want to lint code, run unit tests and perform other useful checks as well!
+
+Example Action, `.github/workflows/ci.yml`:
+
+```yml
+name: CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v3
+    - name: Restore tools
+      run: dotnet tool restore
+    - name: Build
+      run: dotnet build YourSolution.sln
+    - name: Documentation
+      run: dotnet fsdocs build
+```
+
+⚠️ Also, never trust any update to `fsdocs` blindly, always check the [release notes](https://github.com/fsprojects/FSharp.Formatting/blob/main/RELEASE_NOTES.md) to see if there are any breaking changes.
+
+
diff --git a/zero-to-hero.tex b/zero-to-hero.tex
new file mode 100644
index 000000000..291217f91
--- /dev/null
+++ b/zero-to-hero.tex
@@ -0,0 +1,392 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{graphicx}
+\usepackage{fancyvrb}
+\usepackage{listings}
+\usepackage[T1]{fontenc}
+\usepackage{hyperref}
+\usepackage{amsmath}
+
+\definecolor{officegreen}{rgb}{0, 0.5, 0}
+\definecolor{navy}{rgb}{0, 0, 0.5}
+\definecolor{linecolor}{rgb}{0.5, 0.6875, 0.6875}
+\definecolor{outputcolor}{rgb}{0.375, 0.375, 0.375}
+
+\newcommand{\id}[1]{\textcolor{black}{#1}}
+\newcommand{\com}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\inact}[1]{\textcolor{gray}{#1}}
+\newcommand{\kwd}[1]{\textcolor{navy}{#1}}
+\newcommand{\num}[1]{\textcolor{officegreen}{#1}}
+\newcommand{\ops}[1]{\textcolor{purple}{#1}}
+\newcommand{\prep}[1]{\textcolor{purple}{#1}}
+\newcommand{\str}[1]{\textcolor{olive}{#1}}
+\newcommand{\lines}[1]{\textcolor{linecolor}{#1}}
+\newcommand{\fsi}[1]{\textcolor{outputcolor}{#1}}
+\newcommand{\omi}[1]{\textcolor{gray}{#1}}
+
+% Overriding color and style of line numbers
+\renewcommand{\theFancyVerbLine}{
+\lines{\small \arabic{FancyVerbLine}:}}
+
+\lstset{%
+  backgroundcolor=\color{gray!15},
+  basicstyle=\ttfamily,
+  breaklines=true,
+  columns=fullflexible
+}
+
+\title{{page-title}}
+\date{}
+
+\begin{document}
+
+\maketitle
+
+
+\section*{Getting Started}
+
+\subsection*{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 \href{https://pages.github.com/}{GitHub Pages}.
+\subsection*{Install the local tool}
+
+
+
+If you don't have a \href{https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use\#create-a-manifest-file}{dotnet tool manifest}, you can create one using \texttt{dotnet new tool-manifest}.
+
+
+Next, we can install \href{https://www.nuget.org/packages/fsdocs-tool/}{fsdocs-tool} using \texttt{dotnet tool install --local fsdocs-tool}.
+
+It is recommended to install this tool as a local tool because it allows us to update to newer versions of the tool at our own pace.
+\subsection*{Create the docs folder}
+
+
+
+After we've installed the tool, we can run \texttt{dotnet fsdocs --help} and see the available commands.
+
+Both \texttt{build} and \texttt{watch} will generate the documentation for a solution and an input folder.
+
+The default folder for \texttt{--input} is the \texttt{./docs} folder, relative to the current working directory.
+
+
+Typically, your project will be structured like this:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\ops{/}\id{repository}\ops{-}\id{root}
+  \id{YourSolution}{.}\id{sln}
+  {.}\ops{/}\id{docs}
+    \id{index}{.}\id{md}
+    \id{other}\ops{-}\id{file}{.}\id{md}
+  {.}\ops{/}\id{src}
+    {.}\ops{/}\id{Project1}\ops{/}\id{Project1}{.}\id{fsproj}
+    {.}\ops{/}\id{Project2}\ops{/}\id{Project2}{.}\id{fsproj}
+
+
+\end{lstlisting}
+
+
+
+It is recommended to have a single solution at the root. In some editors, it is more convenient to open a solution at the root, to easily manipulate any file in the root repository folder.
+
+When users clone your repository locally, they cannot be confused on how they need to open the project in their IDE.
+
+
+⚠️ Please avoid putting your solution in the \texttt{src} folder. When we open that solution, it can be more difficult to edit files in the \texttt{docs} folder, as we can sometimes only see the \texttt{src} folder.
+
+
+That being said, let's create the \texttt{docs} folder and a first Markdown file named \texttt{index.md}.
+
+When \texttt{fsdocs} runs, it will transform this \texttt{index.md} file to \texttt{index.html}, which will be served at the root.
+
+
+We can put \texttt{\# Hello world} in the markdown file for now.
+
+
+Having this in place, should already serve the first page when we start the \texttt{watch} command:
+\begin{quote}
+
+
+dotnet fsdocs watch
+\end{quote}
+
+
+
+Open \href{http://localhost:8901}{\href{http://localhost:8901}{http://localhost:8901}} and you should see our first page!
+
+
+🪄 You might notice that there are some images missing. You can add these in the \texttt{docs} folder in the right location.
+\subsection*{Generating API documentation}
+
+
+
+By default, \texttt{fsdocs} will generate API documentation for the configured \texttt{--projects}.
+
+When this flag is not specified, \texttt{fsdocs} will look for solutions or projects in the working directory.
+
+It will filter these found projects, the requirements are:
+\begin{itemize}
+\item Having \texttt{library}
+
+\item Having a binary, so you need to build your project first before the documentation can be generated.
+
+\item Not having \texttt{true}
+
+\item Having \texttt{true}
+
+\end{itemize}
+
+
+
+🪄 If you made some changes in order to adhere to the rules, you may want to remove the \texttt{.fsdocs/cache} file.
+\subsection*{Adding the missing properties}
+
+
+
+After our initial \texttt{watch} run, you may have noticed that some links aren't working yet.
+
+\texttt{License}, \texttt{Releases Notes} and \texttt{Source Repository} can be provided by setting MSBuild properties.
+
+
+You can either add these properties to a single \texttt{.fsproj} file, or more typically, add them to a \href{https://learn.microsoft.com/visualstudio/msbuild/customize-by-directory}{Directory.Build.props} file.
+
+The simplest \texttt{Directory.Build.props} file:
+\begin{lstlisting}
+
+    
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md
+        https://github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE_NOTES.md
+        https://fsprojects.github.io/FSharp.AWS.DynamoDB
+    
+
+
+\end{lstlisting}
+
+
+🪄 If you don't have any release notes yet, you could consider using \href{https://github.com/ionide/KeepAChangelog}{Ionide.KeepAChangelog}.
+
+
+Running \texttt{dotnet fsdocs watch} will now yield:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+  \id{root} \ops{-->} \id{https}{:}\com{//github.com/fsprojects/FSharp.AWS.DynamoDB/}
+  \ops{..}{.}
+  \id{fsdocs}\ops{-}\id{license}\ops{-}\id{link} \ops{-->} \id{https}{:}\com{//github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/License.md}
+  \id{fsdocs}\ops{-}\id{release}\ops{-}\id{notes}\ops{-}\id{link} \ops{-->} \id{https}{:}\com{//github.com/fsprojects/FSharp.AWS.DynamoDB/blob/master/RELEASE\_NOTES.md}
+  \ops{..}{.}
+  \id{fsdocs}\ops{-}\id{repository}\ops{-}\id{link} \ops{-->} \id{https}{:}\com{//github.com/fsprojects/FSharp.AWS.DynamoDB/}
+
+
+\end{lstlisting}
+
+
+
+⚠️ Again, you might need to remove \texttt{.fsdocs/cache} in order for changes to be picked up!
+
+
+\texttt{} is actually a very important property when you run \texttt{dotnet fsdocs build}.
+
+\texttt{build} will generate static files for the targeted production environment. In our case, this will be GitHub Pages.
+
+
+Pages will host your files from \href{https://github.com/user/project}{https://github.com/user/project} on \texttt{https://user.github.io/project/} by default.
+
+You can change this by adding a custom domain so we need to be sure that all links and urls will be generated correctly during a build.
+
+
+Let's now run \texttt{dotnet fsdocs build}.
+
+
+\texttt{} will replace the \texttt{\{\{root\}\}} substitution, which is used all over the place in the default template.
+
+
+⚠️ You want to ensure that the static files in the \texttt{output} folder (after running the build) have the correct links.
+\subsection*{Ignore generated files}
+
+
+
+Alright, at this point we've made a lot of progress. If you are using \texttt{git} you want to add the following to your \href{https://git-scm.com/docs/gitignore}{.gitignore} file.
+\begin{lstlisting}
+# FSharp.Formatting
+.fsdocs/
+output/
+tmp/
+
+\end{lstlisting}
+\subsection*{Ship it!}
+
+
+
+Once we are satisfied with our documentation, we want to publish it to GitHub Pages.
+We can use \href{https://github.com/features/actions}{GitHub Actions} to deploy our website.
+
+
+Deploy to Pages from GitHub Actions must be enabled in the repository settings:
+
+
+\begin{figure}[htbp]\centering
+\includegraphics[width=1.0\textwidth]{./content/img/github-pages-settings.png}
+\caption{Enable deploy from Actions}
+\end{figure}
+
+
+
+The typical flow is to publish your documentation after a release or after new commits were added to the default branch.
+
+Let's create a very basic Action that will deploy our website after pushing to the main:
+
+
+Create a file \texttt{.github/workflows/docs.yml}:
+\begin{lstlisting}
+name: Docs
+
+# Trigger this Action when new code is pushed to the main branch
+on:
+  push:
+    branches:
+      - main
+
+# We need some permissions to publish to Github Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the source code
+      - uses: actions/checkout@v4
+      # Setup dotnet, please use a global.json to ensure the right SDK is used!
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+      # Restore the local tools
+      - name: Restore tools
+        run: dotnet tool restore
+      # Build the code for the API documentation
+      - name: Build code
+        run: dotnet build -c Release YourSolution.sln
+      # Generate the documentation files
+      - name: Generate the documentation'
+        run: dotnet fsdocs build --properties Configuration=Release
+      # Upload the static files
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./output
+  
+  # GitHub Actions recommends deploying in a separate job.
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+
+\end{lstlisting}
+
+
+⚠️ Careful yaml is indentation sensitive!
+\subsection*{Next steps}
+
+
+
+Mission accomplished, right? If everything went well, you should have a published website at this point!
+
+Here are some next steps you could consider:
+\subsubsection*{Use fsx file in your documentation}
+
+
+
+Create documentation using \href{../literate.html}{Literate Scripts}. A typical flow here is that you load your locate project binary into a script and create examples using the latest code:
+\begin{lstlisting}[numbers=left]
+
+[escapeinside=\\\{\}]
+\prep{\#r} \str{"../src/Project1/bin/Debug/net6.0/Project1.dll"}
+
+\kwd{open} \id{Project1}
+
+\com{// Actual consumption of your project!}
+\kwd{let} \id{result} \ops{=} \id{SomeType}{.}\id{SomeMethod}{(}\str{"foo"}{)}
+
+
+\end{lstlisting}
+
+
+
+When using the \texttt{--strict} flag in \texttt{dotnet fsdocs build}, your documentation generation will fail if your script contains errors.
+
+This is useful to ensure your documentation is always in sync with your latest public API!
+\subsubsection*{Automatically update to newer versions of fsdocs-tool}
+
+
+
+Using \href{https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates}{Dependabot} you can easily receive new PR's with updates to your \texttt{dotnet} dependencies.
+
+
+Create a \texttt{.github/dependabot.yml} file with:
+\begin{lstlisting}
+version: 2
+updates:
+  # Update to newer version of GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Update to newer NuGet dependencies
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+\end{lstlisting}
+
+
+This will automatically create a new PR when there is an update to the \texttt{fsdocs} tool.
+
+
+⚠️ P️lease be very careful, if you have followed along, we don't have any GitHub Actions right now that run against pull requests!
+
+It is recommended to have an Action that builds your documentation against any incoming changes.
+
+You typically want to lint code, run unit tests and perform other useful checks as well!
+
+
+Example Action, \texttt{.github/workflows/ci.yml}:
+\begin{lstlisting}
+name: CI
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v3
+    - name: Restore tools
+      run: dotnet tool restore
+    - name: Build
+      run: dotnet build YourSolution.sln
+    - name: Documentation
+      run: dotnet fsdocs build
+
+\end{lstlisting}
+
+
+⚠️ Also, never trust any update to \texttt{fsdocs} blindly, always check the \href{https://github.com/fsprojects/FSharp.Formatting/blob/main/RELEASE\_NOTES.md}{release notes} to see if there are any breaking changes.
+
+
+\end{document}
\ No newline at end of file