github
/
hugo-geekblog
mirror of https://github.com/thegeeklab/hugo-geekblog.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: explain `buildDrafts` flag in getting started guide (#501)

This commit is contained in:
Robert Kaussow 2024-02-11 13:44:21 +01:00 committed by GitHub
parent 833d108d57
commit b8ca2dd86e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
exampleSite/content/posts/usage/getting-started.md
View File

@ -124,6 +124,8 @@ To prepare your new site environment just a few steps are required:
hugo server -D
```
The `-D` or `--buildDrafts` option is used to include content marked as draft during the build. It is used because content pages created with the `hugo new content` command have the `draft` flag set by default and this can lead to build errors in newly created projects. For projects with a production-ready content structure, this flag is not required in most cases and can be omitted.
If you want to add some demo data you could use the content from the [Hugo basic example](https://github.com/gohugoio/hugoBasicExample):
```shell