Skip to content

Commit

Permalink
Re-render function docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Olical committed Sep 8, 2023
1 parent 85e09c8 commit 979dbfc
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
21 changes: 20 additions & 1 deletion docs/api/nfnl/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- [`cfg-fn`](#cfg-fn)
- [`config-file-path?`](#config-file-path)
- [`default`](#default)
- [`find`](#find)
- [`find-and-load`](#find-and-load)

## `cfg-fn`
Expand Down Expand Up @@ -34,7 +35,25 @@ Function signature:
(default opts)
```

**Undocumented**
Returns the default configuration that you should base your custom
configuration on top of. Feel free to call this with no arguments and merge
your changes on top. If you wish, you can override opts.root-dir (which
defaults to the dir of your .nfnl.fnl project root and the CWD as a backup)
to whatever you need. The defaults with no arguments should be exactly what
you need in most cases though.

Make sure you update the README whenever you change the default
configuration!

## `find`
Function signature:

```
(find dir)
```

Find the nearest .nfnl.fnl file to the given directory. Returns the absolute
path to the found file or nil.

## `find-and-load`
Function signature:
Expand Down
4 changes: 2 additions & 2 deletions docs/api/nfnl/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,10 +426,10 @@ Return the first truthy result from (f x) or nil.
Function signature:

```
(spit path content)
(spit path content opts)
```

Spit the string into the file.
Spit the string into the file. When opts.append is true, add to the file.

## `str`
Function signature:
Expand Down

0 comments on commit 979dbfc

Please sign in to comment.