github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-24 00:21:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix example in docs that wouldn't work in practice

Browse source 
The pflag package used in hugo has to use the "=" sign
for double dash options such as --source. Thus the original
example `--source ~/mysite` is already incorrect. Adding
the = sign though woul not fix things in this case, since
`--source=~/mysite` does not get resolved to /home/username/mysite,
but looks for the ./~/mysite directory within the current directory.

To resolve this, either the directory name has to be changed in
the docs not to use the "~" sign, or have to change to use the
single dash version of the command line flag. The latter seems
to be more in line with the rest of the example.

Leaving `--watch` as a double dash option to minimize the change,
though it could be either way, since the follow up example uses
the single dash version of both.
This commit is contained in:
Gergely Imreh 2013-08-05 21:45:01 +08:00
parent 57b206ca11
commit f31ec3c280
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/content/doc/usage.md
View file

@ -37,7 +37,7 @@ immediately, tell Hugo to watch for changes. **It will
recreate the site faster than you can tab over to
your browser to view the changes.**
$ hugo --source ~/mysite --watch
$ hugo -s ~/mysite --watch
Watching for changes. Press ctrl+c to stop
15 pages created
0 tags created