From b8ca2dd86e3e7c3af4845e025acb85f3202fe928 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sun, 11 Feb 2024 13:44:21 +0100 Subject: [PATCH] docs: explain `buildDrafts` flag in getting started guide (#501) --- exampleSite/content/posts/usage/getting-started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/exampleSite/content/posts/usage/getting-started.md b/exampleSite/content/posts/usage/getting-started.md index 579a863..39a51ea 100644 --- a/exampleSite/content/posts/usage/getting-started.md +++ b/exampleSite/content/posts/usage/getting-started.md @@ -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