2
2
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-05 18:42:04 +00:00
Hilbish/docs/api/fs.md
TorchedSammy 1b24e91597
feat!: enhance docs and doc command
changes the actual file format of docs
to markup since that's basically what we have been
using in the first place.

the docgen command has been modified to write
markdown headings with the function name and
yaml metadata for easy consumption by hugo for the
website (soon).

all other docs have been moved to markdown as well
this is the main reason this is a "breaking" change
users will have to reinstall hilbish
(task uninstall and task install) to remove the old
plaintext docs
2022-12-02 15:08:03 -04:00

804 B

name description layout
Module fs apidoc

Introduction

Functions

abs(path)

Gives an absolute version of path.

basename(path)

Gives the basename of path. For the rules, see Go's filepath.Base

cd(dir)

Changes directory to dir

dir(path)

Returns the directory part of path. For the rules, see Go's filepath.Dir

glob(pattern)

Glob all files and directories that match the pattern. For the rules, see Go's filepath.Glob

join(paths...)

Takes paths and joins them together with the OS's directory separator (forward or backward slash).

mkdir(name, recursive)

Makes a directory called name. If recursive is true, it will create its parent directories.

readdir(dir)

Returns a table of files in dir

stat(path)

Returns info about path