346b60358d
73a01565c Remove comment shortcode documentation 0ca7ccd30 Replace usage of comment shortcode with HTML comments fe10d9899 Remove expired new-in labels 11e89dfcb [editorial] Link to proper render-hook page in relref.md 11a581c2f netlify: Hugo 0.142.0 1a4fcf7f7 Miscellaneous edits 2c7a3165f Markdown linting and cleanup 69d7a781b Replace links to glossary terms with custom render hook syntax 441752d2d Refactor glossary lookup portion of link render hook 80109a14f Fix glossary term linking for plural form cd95f0f34 Update link render hook to support glossary links 53eadb430 Remove the glossary template 1d40a7f3b Improve transform.ToMath examples 586970df2 Misc edits 6a06a8de7 Add glossary link shortcode 4171c0eb7 Improve description of masking with non-transparent images 41c8feb64 Fix example of image.Mask filter 704a81656 Add alignx option to images.Text usage example 7c03eb0cc Clarify context in example of using the try statement 56d9c9b71 Refactor glossary of terms 042a6846b Add expiry dates to deprecated methods pages 365ab345f Remove services key from instagram shortcode page b7fe31e07 Reorder options list for images.Text filter 8051ff818 Format directory names, file names, and file paths as code d09a14623 Update version refs for Hugo and Dart Sass 3bb006974 Add NODE_VERSION to Netlify config examples 3a0f2531e Fix typo 7e3198eaf Fix typo cf56452a3 Fix typo a9f51d13e Fix typo 82bfdd8c3 Fix typo a5c41a053 Fix typo abcfed7a5 Fix typo 8c1debf3a Remove outdated new-in badges 809ddf9ef Update theme 63867d56f Use warnf instead of errorf in try-catch example dee3e5f09 Update theme 9791f7057 Remove TODO from comment shortcode examples a346ca1fd Elevate embedded shortcode documentation to its own section 8fa19b50f hugoreleaser.toml => hugoreleaser.yaml 575d60345 Update docs for v0.141.0 a0a442d62 netlify: Hugo 0.141.0 6667cbcd8 Merge commit '81a7b6390036138356773c87a886679c81c524e1' f36fc013e docs: Regen CLI docs 365a47ded tpl/images: Change signature of images.QR to images.QR TEXT OPTIONS ae8f8af0a images.Text: Add "alignx" option for horizontal alignment 8f45ccca6 docs: Regen CLI docs f0e6304f4 Merge commit 'e9fbadacc3f09191e2e19f112a49777eeb8df06c' cb9bec2b2 tpl/images: Add images.QR function git-subtree-dir: docs git-subtree-split: 73a01565c5ba0774d65aa6f2384c44804fefa37d
3.9 KiB
| title | description | categories | keywords | menu | weight | toc | aliases | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Data sources | Use local and remote data sources to augment or create content. |
|
|
|
280 | true |
|
Hugo can access and unmarshal local and remote data sources including CSV, JSON, TOML, YAML, and XML. Use this data to augment existing content or to create new content.
A data source might be a file in the data directory, a global resource, a page resource, or a remote resource.
Data directory
The data directory in the root of your project may contain one or more data files, in either a flat or nested tree. Hugo merges the data files to create a single data structure, accessible with the Data method on a Site object.
Hugo also merges data directories from themes and modules into this single data structure, where the data directory in the root of your project takes precedence.
{{% note %}} Hugo reads the combined data structure into memory and keeps it there for the entire build. For data that is infrequently accessed, use global or page resources instead. {{% /note %}}
Theme and module authors may wish to namespace their data files to prevent collisions. For example:
project/
└── data/
└── mytheme/
└── foo.json
{{% note %}}
Do not place CSV files in the data directory. Access CSV files as page, global, or remote resources.
{{% /note %}}
See the documentation for the Data method on a Site object for details and examples.
Global resources
Use the resources.Get and transform.Unmarshal functions to access data files that exist as global resources.
See the transform.Unmarshal documentation for details and examples.
Page resources
Use the Resources.Get method on a Page object combined with the transform.Unmarshal function to access data files that exist as page resources.
See the transform.Unmarshal documentation for details and examples.
Remote resources
Use the resources.GetRemote and transform.Unmarshal functions to access remote data.
See the transform.Unmarshal documentation for details and examples.
Augment existing content
Use data sources to augment existing content. For example, create a shortcode to render an HTML table from a global CSV resource.
{{< code file=assets/pets.csv >}} "name","type","breed","age" "Spot","dog","Collie","3" "Felix","cat","Malicious","7" {{< /code >}}
{{< code file=content/example.md lang=text >}} {{</* csv-to-table "pets.csv" */>}} {{< /code >}}
{{< code file=layouts/shortcodes/csv-to-table.html >}} {{ with $file := .Get 0 }} {{ with resources.Get $file }} {{ with . | transform.Unmarshal }} {{ range index . 0 }} {{ end }} {{ range after 1 . }} {{ range . }} {{ end }} {{ end }}
| {{ . }} |
|---|
| {{ . }} |
file .Position }}
{{ end }}
{{ else }}
{{ errorf "The %q shortcode requires one positional argument, the path to the CSV file relative to the assets directory. See %s" .Name .Position }}
{{ end }}
{{< /code >}}
Hugo renders this to:
| name | type | breed | age |
|---|---|---|---|
| Spot | dog | Collie | 3 |
| Felix | cat | Malicious | 7 |
Create new content
Use content adapters to create new content.