mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
7c62d6ef16
a7e1e9be8 Clarify front matter date fields 69df4fc22 Clarify how to determine if .Inner is populated 9046bf424 Document strings.ContainsNonSpace 8dbe5df90 Fix indentation and broken image 48ad4124e Typo: functions/after.md d4c01b57b Link to detailed descriptions of canonfiyURLs and relativeURLs 4d9597302 Explain behaviour when appending to a slice containing other slices 69e24e44e Standardize right arrow usage 01b378726 Remove references to Google's Universal Analytics and the async template d415bae24 Use shared file to describe regex syntax e75dee6b8 snap: How to enable or revoke access to SSH keys feed2d1c0 Remove hasPrefix and hasSuffix in favor of namespaced versions 3c6d2cfe5 security: Use default execution settings 461b5fcaf netlify: Hugo 0.116.1 95fac27a5 configuration: correct cacheDir description cd9f1f929 configuration: Fix broken link 605394de4 netlify: Upgrade to Hugo 0.116.0 baf2a0f7b Merge branch 'tempv0.116.0' ee51a9323 Update requirements for building from source 40189956d Editor tools: Remove duplicate sentence fb0ff2621 docs: Regenerate CLI docs e8a5665c4 Update where.md 7bc5cf15d Update hosting instructions 018a04314 docs: Update where d33ae91cf docs: Update where function operators 9a108a664 docs: Rework the cacheDir documentation git-subtree-dir: docs git-subtree-split: a7e1e9be851b95e636ab5360e5151156b4f89044
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
---
|
|
title: readDir
|
|
description: Returns an array of FileInfo structures sorted by file name, one element for each directory entry.
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: functions
|
|
keywords: [files]
|
|
signature: ["os.ReadDir PATH", "readDir PATH"]
|
|
relatedfuncs: ['os.FileExists','os.ReadFile','os.Stat']
|
|
---
|
|
The `os.ReadDir` function resolves the path relative to the root of your project directory. A leading path separator (`/`) is optional.
|
|
|
|
With this directory structure:
|
|
|
|
```text
|
|
content/
|
|
├── about.md
|
|
├── contact.md
|
|
└── news/
|
|
├── article-1.md
|
|
└── article-2.md
|
|
```
|
|
|
|
This template code:
|
|
|
|
```go-html-template
|
|
{{ range os.ReadDir "content" }}
|
|
{{ .Name }} → {{ .IsDir }}
|
|
{{ end }}
|
|
```
|
|
|
|
Produces:
|
|
|
|
```html
|
|
about.md --> false
|
|
contact.md --> false
|
|
news --> true
|
|
```
|
|
|
|
Note that `os.ReadDir` is not recursive.
|
|
|
|
Details of the `FileInfo` structure are available in the [Go documentation](https://pkg.go.dev/io/fs#FileInfo).
|
|
|
|
For more information on using `readDir` and `readFile` in your templates, see [Local File Templates](/templates/files).
|