Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--watch expectation #910

Open
Fxplorer opened this issue Mar 16, 2024 · 1 comment
Open

--watch expectation #910

Fxplorer opened this issue Mar 16, 2024 · 1 comment

Comments

@Fxplorer
Copy link
Contributor

Fxplorer commented Mar 16, 2024

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
Copy link
Collaborator

nhirschey commented Mar 17, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants