If creating a new entry via the terminal:
- The Hugo terminal command for creating a new
article
is:
This will create new file athugo new article/article-short-title.md
content/article/article-short-title.md
. The new file will be created according to the archetype for articles atroot/archetypes/article.md
. The new file will be created as a draft (draft: true
) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content.
If creating a new entry via the online preview page:
- the new entry will be empty. Please use the sample §⁄YAML header below as starting point, and also copy to the new file the §⁄instructions provided below.
1. Sample YAML header¶
---
title: "Title sample ⚫ 📑"
date: "2023-07-13T14:15:10+03:00"
author: "file-creator-put-your-name-here"
contributors: ["jane-contributor.md"]
draft: true
keywords:
- draft
abstract: |
The text of your abstract.
---
2. Instructions for article-file creator/editor¶
- Put a checkmark to all items of this list that have been completed. This, by changing:
1. [ ]
to1. [x]
- File naming: Follow article⁄conventions for article file-naming. Example:
i5-short-title.md
(where i5 is issue 5) - (File editor) Insert your name in the
author
field inside “quotation marks” as in:author: "creators-name"
- Set the
title
to the title of the article as in:title: "An Answer to the Question: What is Game Design Research"
- Create entries for article contributors – if they are not there – and add their bio/info.
- Add the article’s author(s) in the
contributors
field as above (comma separated; inside quotation marks; including extension):contributors: ["jane-contributor.md", "some-other.md"]
- Add article keywords. Follow exact formatting as above, otherwise the file/site will break.
keywords: - keyword one - keyword two
- Fill the abstract following exact formatting like above, otherwise the site will break.
- Parent article to issue: go to
content/issue/some-issue.md
and add the name of this file (not title) to the fieldhas_articles
. Example:has_articles: ["this-articles-file-name.md"]
- Add article content text below this section.
- Log potential problems with this article by making another check-list below (commented sample lists provided below).
- Git commit and push if/when applicable; providing a commit message describing your changes.
- Set the draft flag accordingly. False will make this public: only do that when ready to publish. Leave
draft: true
when in-progress. - Feel free to put this block inside comments, to be able to view the actual content properly.
- Delete this section when all is in order.
- Done!