hugo/docs/content/en/functions/os/ReadDir.md
2023-10-20 09:43:56 +02:00

1.2 KiB

title linkTitle description categories keywords menu function relatedFunctions aliases
os.ReadDir readDir Returns an array of FileInfo structures sorted by file name, one element for each directory entry.
functions
docs
parent
functions
aliases returnType signatures
readDir
FileInfo
os.ReadDir PATH
os.FileExists
os.Getenv
os.ReadDir
os.ReadFile
os.Stat
/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 os.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.