Header menu logo docs-template

Binder  Script  Notebook

How to add these badges?

Including notebooks

To include dotnet interactive notebooks in the ipynb format, it is enough for the _template.ipynb file to simply exist.

There are however some customization options with fsdocs that move your documentation to the next level:

Conditional package references

use the IPYNB compiler directive in conjuntion with condition:ipynb to include blocks only in the rendered notebook file.

This is especially usefull for referencing packages that otherwise be referenced locally during yopur buildchain:

#r "/path/to/your/binaries/during/local/build"

(***condition:ipynb***)
#if IPYNB
#r "nuget: yourProjectOnNuget, 1.3.3.7"
#endif // IPYNB

Conditional value inclusion

Sometimes the content you want to include might differ aswell. An example is Plotly.NET charts. While you want to dump the chart html directly into the html docs via (include-it-raw), you want to end cells in notebooks with the chart value itself to include the chart in the output cell with Plotly.NET.Interactive.

Here is an example for such an conditional block:

open Plotly.NET

let myChart = Chart.Point([1.,2.])

(***condition:ipynb***)
#if IPYNB
myChart
#endif // IPYNB

(***hide***)
myChart |> GenericChart.toChartHTML
(***include-it-raw***)

open Plotly.NET

let myChart = Chart.Point([1.,2.])

Including binder links

Binder is an awesome project that launches an instance of your notebook given the correct Dockerfile and nuget.config, which will be added automatically by the fsdocs tool when you build the docs.

you can include a binder link like this (supposed you use gh-pages to host your docs):

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/<YOUR-ORG>/<YOUR-PROJECT>/gh-pages?filepath=<YOUR-DOCS-FILENAME>.ipynb)

In fact, you can use this link here to check the conditionals of this very page in a notebook:

Binder

namespace Plotly
namespace Plotly.NET
val myChart: GenericChart.GenericChart
type Chart = static member Area: x: #IConvertible seq * y: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?ShowMarkers: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?MarkerSymbol: Symbol * [<Optional; DefaultParameterValue ((null :> obj))>] ?Color: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Labels: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextPosition: TextPosition * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<Optional; DefaultParameterValue ((null :> obj))>] ?Dash: DrawingStyle * [<Optional; DefaultParameterValue ((null :> obj))>] ?Width: float -> GenericChart + 1 overload static member Bar: keys: #IConvertible seq * values: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Color: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Labels: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextPosition: TextPosition * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<Optional; DefaultParameterValue ((null :> obj))>] ?Marker: Marker -> GenericChart + 1 overload static member BoxPlot: [<Optional; DefaultParameterValue ((null :> obj))>] ?x: 'a0 * [<Optional; DefaultParameterValue ((null :> obj))>] ?y: 'a1 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Color: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Fillcolor: 'a2 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Whiskerwidth: 'a3 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Boxpoints: Boxpoints * [<Optional; DefaultParameterValue ((null :> obj))>] ?Boxmean: BoxMean * [<Optional; DefaultParameterValue ((null :> obj))>] ?Jitter: 'a4 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Pointpos: 'a5 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Orientation: Orientation * [<Optional; DefaultParameterValue ((null :> obj))>] ?Marker: Marker * [<Optional; DefaultParameterValue ((null :> obj))>] ?Line: Line * [<Optional; DefaultParameterValue ((null :> obj))>] ?Alignmentgroup: 'a6 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Offsetgroup: 'a7 * [<Optional; DefaultParameterValue ((null :> obj))>] ?Notched: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?NotchWidth: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?QuartileMethod: QuartileMethod -> GenericChart + 1 overload static member Bubble: x: #IConvertible seq * y: #IConvertible seq * sizes: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?MarkerSymbol: Symbol * [<Optional; DefaultParameterValue ((null :> obj))>] ?Color: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Labels: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextPosition: TextPosition * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<Optional; DefaultParameterValue ((null :> obj))>] ?StackGroup: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Orientation: Orientation * [<Optional; DefaultParameterValue ((null :> obj))>] ?GroupNorm: GroupNorm * [<Optional; DefaultParameterValue ((false :> obj))>] ?UseWebGL: bool -> GenericChart + 1 overload static member Candlestick: ``open`` : #IConvertible seq * high: #IConvertible seq * low: #IConvertible seq * close: #IConvertible seq * x: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Increasing: Line * [<Optional; DefaultParameterValue ((null :> obj))>] ?Decreasing: Line * [<Optional; DefaultParameterValue ((null :> obj))>] ?WhiskerWidth: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Line: Line * [<Optional; DefaultParameterValue ((null :> obj))>] ?XCalendar: Calendar -> GenericChart + 1 overload static member ChoroplethMap: locations: string seq * z: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Text: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Locationmode: LocationFormat * [<Optional; DefaultParameterValue ((null :> obj))>] ?Autocolorscale: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorscale: Colorscale * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorbar: Colorbar * [<Optional; DefaultParameterValue ((null :> obj))>] ?Marker: Marker * [<Optional; DefaultParameterValue ((null :> obj))>] ?GeoJson: 'a2 * [<Optional; DefaultParameterValue ((null :> obj))>] ?FeatureIdKey: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Zmin: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Zmax: float -> GenericChart static member ChoroplethMapbox: locations: #IConvertible seq * z: #IConvertible seq * geoJson: 'a2 * [<Optional; DefaultParameterValue ((null :> obj))>] ?FeatureIdKey: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Text: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Below: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorscale: Colorscale * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorbar: Colorbar * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZAuto: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMin: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMid: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMax: float -> GenericChart static member Column: keys: #IConvertible seq * values: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Color: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Labels: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextPosition: TextPosition * [<Optional; DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<Optional; DefaultParameterValue ((null :> obj))>] ?Marker: Marker -> GenericChart + 1 overload static member Contour: data: #('a1 seq) seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?X: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Y: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Name: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorscale: Colorscale * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showscale: 'a4 * [<Optional; DefaultParameterValue ((null :> obj))>] ?zSmooth: SmoothAlg * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorbar: 'a5 -> GenericChart (requires 'a1 :> IConvertible) static member DensityMapbox: lon: #IConvertible seq * lat: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Z: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Radius: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?Text: #IConvertible seq * [<Optional; DefaultParameterValue ((null :> obj))>] ?Below: string * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorscale: Colorscale * [<Optional; DefaultParameterValue ((null :> obj))>] ?Colorbar: Colorbar * [<Optional; DefaultParameterValue ((null :> obj))>] ?Showscale: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZAuto: bool * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMin: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMid: float * [<Optional; DefaultParameterValue ((null :> obj))>] ?ZMax: float -> GenericChart + 1 overload ...
<summary> Provides a set of static methods for creating charts. </summary>
static member Chart.Point: xy: (#System.IConvertible * #System.IConvertible) seq * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Name: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?MarkerSymbol: StyleParam.Symbol * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Color: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Labels: #System.IConvertible seq * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?TextPosition: StyleParam.TextPosition * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?StackGroup: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Orientation: StyleParam.Orientation * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?GroupNorm: StyleParam.GroupNorm * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((false :> obj))>] ?UseWebGL: bool -> GenericChart.GenericChart
static member Chart.Point: x: #System.IConvertible seq * y: #System.IConvertible seq * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Name: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Showlegend: bool * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?MarkerSymbol: StyleParam.Symbol * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Color: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Opacity: float * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Labels: #System.IConvertible seq * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?TextPosition: StyleParam.TextPosition * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?TextFont: Font * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?StackGroup: string * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?Orientation: StyleParam.Orientation * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((null :> obj))>] ?GroupNorm: StyleParam.GroupNorm * [<System.Runtime.InteropServices.Optional; System.Runtime.InteropServices.DefaultParameterValue ((false :> obj))>] ?UseWebGL: bool -> GenericChart.GenericChart
module GenericChart from Plotly.NET
<summary> Module to represent a GenericChart </summary>
val toChartHTML: gChart: GenericChart.GenericChart -> string
<summary> Converts a GenericChart to it HTML representation. The div layer has a default size of 600 if not specified otherwise. </summary>

Type something to start searching.