Skip to content

Commit

Permalink
Update README.md (#389)
Browse files Browse the repository at this point in the history 
Add that preview does not work with windows
  • Loading branch information
@simoninithomas
simoninithomas authored Dec 6, 2022
1 parent 1de77e9 commit dbbb0c5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ pip install hf-doc-builder
doc-builder preview course ../course/chapters/LANG-ID --not_python_module
```
**`preview` command does not work with Windows.
This will build and render the course on [http://localhost:3000/](http://localhost:3000/). Although the content looks much nicer on the Hugging Face website, this step will still allow you to check that everything is formatted correctly.
**🚀 Submit a pull request**
Expand Down

0 comments on commit dbbb0c5

Please sign in to comment.