fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
462 stars 155 forks source link

Use fsdocs command line tool to convert single files #811

Open nhirschey opened 1 year ago

nhirschey commented 1 year ago

In pandoc you can write pandoc notebook.ipynb -s -o notebook.html to create a standalone html page. It would be nice to have similar functionality for single documents.

It would also be helpful if you have a large repo where you're developing a page and building the full site takes a long time; currently I copy the file I'm developing to a separate repo to avoid the long build time. This would alleviate that problem, via something like dotnet fsdocs standalone watch file.fsx.

Perhaps something like dotnet fsdocs convert notebook.ipynb -o notebook.html or dotnet fsdocs standalone notebook.ipynb -o notebook.html. It should accept .md, .fsx, .ipynb, (and .latex ?) as input.

It's possible using the literate functions (see Literate docs), but they need to be exposed via the command line tool.

cc: @kMutagene

Fxplorer commented 3 months ago

and .dib