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

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

This commit is contained in:
Robert Kaussow 2024-02-11 13:44:25 +01:00 committed by GitHub
parent 392fa73eba
commit f5ea5f0ef6
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/en/usage/getting-started.md
View File

@ -80,6 +80,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.
### Option 1: Download pre-build release bundle
Download and extract the latest release bundle into the theme directory.