diff options
Diffstat (limited to 'content/post/archetypes.md')
| -rw-r--r-- | content/post/archetypes.md | 129 |
1 files changed, 0 insertions, 129 deletions
diff --git a/content/post/archetypes.md b/content/post/archetypes.md deleted file mode 100644 index 967945e..0000000 --- a/content/post/archetypes.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2014-05-14T02:13:50Z -menu: - main: - parent: content -next: /content/ordering -prev: /content/types -title: Archetypes -weight: 50 -toc: true ---- - -Hugo v0.11 introduced the concept of a content builder. Using the -command: <code>hugo new <em>[relative new content path]</em></code>, -you can start a content file with the date and title automatically set. -While this is a welcome feature, active writers need more. - -Hugo presents the concept of archetypes, which are archetypal content files -with pre-configured [front matter](/content/front-matter) which will -populate each new content file whenever you run the `hugo new` command. - - -## Example - -### Step 1. Creating an archetype - -In this example scenario, we have a blog with a single content type (blog post). -We will use ‘tags’ and ‘categories’ for our taxonomies, so let's create an archetype file with ‘tags’ and ‘categories’ pre-defined, as follows: - -#### archetypes/default.md - -```toml -+++ -tags = ["x", "y"] -categories = ["x", "y"] -+++ -``` - -> __CAVEAT:__ Some editors (e.g. Sublime, Emacs) do not insert an EOL (end-of-line) character at the end of the file (i.e. EOF). If you get a [strange EOF error](/troubleshooting/strange-eof-error/) when using `hugo new`, please open each archetype file (i.e. `archetypes/*.md`) and press <kbd>Enter</kbd> to type a carriage return after the closing `+++` or `---` as necessary. - - -### Step 2. Using the archetype - -Now, with `archetypes/default.md` in place, let's create a new post in the `post` section with the `hugo new` command: - - $ hugo new post/my-new-post.md - -Hugo would create the file with the following contents: - -#### content/post/my-new-post.md - -```toml -+++ -title = "my new post" -date = "2015-01-12T19:20:04-07:00" -tags = ["x", "y"] -categories = ["x", "y"] -+++ -``` - -We see that the `title` and `date` variables have been added, in addition to the `tags` and `categories` variables which were carried over from `archetype/default.md`. - -Congratulations! We have successfully created an archetype and used it for our new contents. But wait, what if I want to have different variables for another content type, like musicians? No problem. - -### Creating custom archetypes - -Earlier you created a new content type by adding a new subfolder to the content directory. In our case it's name would be `content/musician`. To use the corresponding archetype you just need to create a file named after the content type called `musician.md` in the `archetypes` directory, similar to the one below. - -#### archetypes/musician.md - -```toml -+++ -name = "" -bio = "" -genre = "" -+++ -``` - -Now let's create a new musician. - - $ hugo new musician/mozart.md - -This time, Hugo recognizes the custom archetype and uses it instead of the default one. So the generated file's frontmatter now includes the variables `name`, `bio` and `genre`. - -#### content/musician/mozart.md - -```toml -+++ -title = "mozart" -date = "2015-08-24T13:04:37+02:00" -name = "" -bio = "" -genre = "" -+++ -``` - -## Using a different front matter format - -By default, the front matter will be created in the TOML format -regardless of what format the archetype is using. - -You can specify a different default format in your site-wide config file -(e.g. `config.toml`) using the `MetaDataFormat` directive. -Possible values are `"toml"`, `"yaml"` and `"json"`. - - -## Which archetype is being used - -The following rules apply: - -* If an archetype with a filename that matches the content type being created, it will be used. -* If no match is found, `archetypes/default.md` will be used. -* If neither is present and a theme is in use, then within the theme: - * If an archetype with a filename that matches the content type being created, it will be used. - * If no match is found, `archetypes/default.md` will be used. -* If no archetype files are present, then the one that ships with Hugo will be used. - -Hugo provides a simple archetype which sets the `title` (based on the -file name) and the `date` in RFC 3339 format based on -[`now()`](http://golang.org/pkg/time/#Now), which returns the current time. - -> *Note: `hugo new` does not automatically add `draft = true` when the user -> provides an archetype. This is by design, rationale being that -> the archetype should set its own value for all fields. -> `title` and `date`, which are dynamic and unique for each piece of content, -> are the sole exceptions.* - -Content type is automatically detected based on the path. You are welcome to declare which type to create using the `--kind` flag during creation. |