Add dynamic archives

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
index 88609682..f4815246 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ The [deployment process](#deployment-process) happens automatically every hour.
 - [Preview the Docs website](#preview-the-docs-website)
     - [Preview on mobile](#preview-on-mobile)
 - [Contributing to the docs website itself](#contributing-to-the-docs-website-itself)
+- [Using YAML data files](#using-yaml-data-files)
 - [Review Apps for documentation merge requests](#review-apps-for-documentation-merge-requests)
 - [Deployment process](#deployment-process)
 
@@ -284,6 +285,38 @@ run without manual intervention, run:
 RAKE_FORCE_DELETE=true rake pull_repos
 ```
 
+## Using YAML data files
+
+The easiest way to achieve something similar to
+[Jekyll's data files](https://jekyllrb.com/docs/datafiles/) in Nanoc is by
+using the [`@items`](https://nanoc.ws/doc/reference/variables/#items-and-layouts)
+variable.
+
+The data file must be placed inside the `content/` directory and then it can
+be referenced in an ERB template.
+
+Suppose we have the `content/_data/versions.yaml` file with the content:
+
+```yaml
+versions:
+- 10.6
+- 10.5
+- 10.4
+```
+
+We can then loop over the `versions` array with something like:
+
+```erb
+<% @items['/_data/versions.yaml'][:versions].each do | version | %>
+
+<h3><%= version %></h3>
+
+<% end &>
+```
+
+Note that the data file must have the `yaml` extension (not `yml`) and that
+we reference the array with a symbol (`:versions`).
+
 ## Review Apps for documentation merge requests
 
 If you are contributing to GitLab docs read how to create a Review App with each