hugo/docs/content/en/functions/os/ReadDir.md
2023-12-04 15:24:01 +01:00

1.1 KiB

title description categories keywords action aliases
os.ReadDir Returns an array of FileInfo structures sorted by file name, one element for each directory entry.
aliases related returnType signatures
readDir
functions/os/FileExists
functions/os/Getenv
functions/os/ReadFile
functions/os/Stat
os.FileInfo
os.ReadDir PATH
/functions/readdir

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:

content/
├── about.md
├── contact.md
└── news/
    ├── article-1.md
    └── article-2.md

This template code:

{{ range readDir "content" }}
  {{ .Name }}{{ .IsDir }}
{{ end }}

Produces:

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.

For more information on using readDir and readFile in your templates, see Local File Templates.