镜像自地址
https://github.com/Hilbis/Hilbish
已同步 2025-07-10 21:12:02 +00:00
sammyette
e5eefb1d2d
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. 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
47 行
1.0 KiB
Markdown
47 行
1.0 KiB
Markdown
---
|
|
title: Module fs
|
|
description: filesystem interaction and functionality library
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
The fs module provides easy and simple access to filesystem functions
|
|
and other things, and acts an addition to the Lua standard library's
|
|
I/O and filesystem functions.
|
|
|
|
## 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`
|
|
|