search

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

--watch expectation #910

Open Fxplorer opened 3 months ago

Fxplorer commented 3 months ago

My expected behavior of fsdocs --watch is that it would be like dotnet watch where when changes to files were made, fsdocs would build again and update the output files. I have reviewed the hot-reload PR that was merged, so it should update the browser with the new generated files. I want to make sure that is what the intent is, right? Mine is not doing that. Doing watch does the initial launch and then says some websocket errors and shutdown messages and leave the blinking courser on an blank line. If i hit enter, the > prompt comes back and fsdocs has ended.

If the watch is supposed to flow as i described previously, I will test on clean windows and linux (Debian) and supply a detailed report of the findings.

nhirschey commented 3 months ago

The syntax is ‘dotnet fsdocs watch’.

More information here https://fsprojects.github.io/FSharp.Formatting/commandline.html#The-watch-command

From that link:

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").