From 64ba30c1694a9a860434360cb3e2b4733b2549d7 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 2 Feb 2023 19:00:48 -0500 Subject: [PATCH] Update blog-post submission instructions (#2251) --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0b0e7c3721cf..2ba2734641ec 100644 --- a/README.md +++ b/README.md @@ -37,15 +37,21 @@ new issue/PR with your content to get it added to the docs. Follow the [setup instructions][contributing.md] then, to create a skeletal blog post, run the following command from the repo root: -```console -$ npx hugo new content/en/blog/2022/short-name-for-your-blog-post/index.md +```sh +npx hugo new content/en/blog/2023/short-name-for-post.md ``` -Start editing the markdown file at the path you provided in the previous +If your post will have images or other assets, instead run: + +```sh +npx hugo new content/en/blog/2023/short-name-for-post/index.md +``` + +Edit the markdown file at the path you provided in the previous command. The file is initialized from the blog-post starter under [archetypes](archetypes). -Put assets like images into the folder created. +Put assets, if any, like images into the folder created. Once your post is ready, submit it through a [pull request][].