Document proper directory names when working with Hugo

[Cli4d]

There needs to be a caution on having whitespace in directory names when working with Hugo. There is an error generated when whitespace is left in the directory names when creating a Hugo site to preview changes. e.g. "work project/docs" will cause an error. It should be "work-project/docs". Or any other way that does not involve the white space.

This needs to be highlighted in the docs ReadMe.

[MattiSG]

Thanks for reporting!

I can't reproduce this issue under macOS:

› pwd
/Users/opentermsarchive/Desktop/folder with spaces/docs copy
› npm run  start:dev
> open-terms-archive-docs@0.0.1 start:dev
> hugo serve --watch --logLevel debug --disableFastRender
Built in 855 ms
Environment: "development"
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) 
Press Ctrl+C to stop

Could you please try running with npm run instead of using hugo directly?

If that solves the problem, then please close this issue. If that does not, please check that there is no open issue on the hugo source repository. If neither, then you can either close this issue considering that this report is helpful enough for others, or open a pull request to add a small note in the README regarding usage of spaces on Windows 🙂