gohugoio-hugo/docs/content/en/functions/readdir.md

title, description, categories, menu, keywords, signature, relatedfuncs

title	description	categories	menu	keywords	signature	relatedfuncs
readDir	Returns an array of FileInfo structures sorted by file name, one element for each directory entry.	functions	docs parent functions	files	os.ReadDir PATH readDir PATH	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:

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.