diff --git a/docs/conversion.md b/docs/README.md similarity index 100% rename from docs/conversion.md rename to docs/README.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..651c3dc --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,23 @@ +# Table of contents + +* [Type Conversion Functions](README.md) +* [Cryptographic and Security Functions](crypto.md) +* [Date Functions](date.md) +* [Default Functions](defaults.md) +* [Dictionaries and Dict Functions](dicts.md) +* [Encoding Functions](encoding.md) +* [Flow Control Functions](flow\_control.md) +* [Sprig Function Documentation](index.md) +* [Integer Slice Functions](integer\_slice.md) +* [Lists and List Functions](lists.md) +* [Integer Math Functions](math.md) +* [Float Math Functions](mathf.md) +* [Network Functions](network.md) +* [OS Functions](os.md) +* [Path and Filepath Functions](paths.md) +* [Reflection Functions](reflection.md) +* [Semantic Version Functions](semver.md) +* [String Slice Functions](string\_slice.md) +* [String Functions](strings.md) +* [URL Functions](url.md) +* [UUID Functions](uuid.md) diff --git a/docs/index.md b/docs/index.md index 7e898fa..01f628a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,23 +2,23 @@ The Sprig library provides over 70 template functions for Go's template language. -- [String Functions](strings.md): `trim`, `wrap`, `randAlpha`, `plural`, etc. - - [String List Functions](string_slice.md): `splitList`, `sortAlpha`, etc. -- [Integer Math Functions](math.md): `add`, `max`, `mul`, etc. - - [Integer Slice Functions](integer_slice.md): `until`, `untilStep` -- [Float Math Functions](mathf.md): `addf`, `maxf`, `mulf`, etc. -- [Date Functions](date.md): `now`, `date`, etc. -- [Defaults Functions](defaults.md): `default`, `empty`, `coalesce`, `fromJson`, `toJson`, `toPrettyJson`, `toRawJson`, `ternary` -- [Encoding Functions](encoding.md): `b64enc`, `b64dec`, etc. -- [Lists and List Functions](lists.md): `list`, `first`, `uniq`, etc. -- [Dictionaries and Dict Functions](dicts.md): `get`, `set`, `dict`, `hasKey`, `pluck`, `dig`, `deepCopy`, etc. -- [Type Conversion Functions](conversion.md): `atoi`, `int64`, `toString`, etc. -- [Path and Filepath Functions](paths.md): `base`, `dir`, `ext`, `clean`, `isAbs`, `osBase`, `osDir`, `osExt`, `osClean`, `osIsAbs` -- [Flow Control Functions](flow_control.md): `fail` -- Advanced Functions - - [UUID Functions](uuid.md): `uuidv4` - - [OS Functions](os.md): `env`, `expandenv` - - [Version Comparison Functions](semver.md): `semver`, `semverCompare` - - [Reflection](reflection.md): `typeOf`, `kindIs`, `typeIsLike`, etc. - - [Cryptographic and Security Functions](crypto.md): `derivePassword`, `sha256sum`, `genPrivateKey`, etc. - - [Network](network.md): `getHostByName` +* [String Functions](strings.md): `trim`, `wrap`, `randAlpha`, `plural`, etc. + * [String List Functions](string\_slice.md): `splitList`, `sortAlpha`, etc. +* [Integer Math Functions](math.md): `add`, `max`, `mul`, etc. + * [Integer Slice Functions](integer\_slice.md): `until`, `untilStep` +* [Float Math Functions](mathf.md): `addf`, `maxf`, `mulf`, etc. +* [Date Functions](date.md): `now`, `date`, etc. +* [Defaults Functions](defaults.md): `default`, `empty`, `coalesce`, `fromJson`, `toJson`, `toPrettyJson`, `toRawJson`, `ternary` +* [Encoding Functions](encoding.md): `b64enc`, `b64dec`, etc. +* [Lists and List Functions](lists.md): `list`, `first`, `uniq`, etc. +* [Dictionaries and Dict Functions](dicts.md): `get`, `set`, `dict`, `hasKey`, `pluck`, `dig`, `deepCopy`, etc. +* [Type Conversion Functions](./): `atoi`, `int64`, `toString`, etc. +* [Path and Filepath Functions](paths.md): `base`, `dir`, `ext`, `clean`, `isAbs`, `osBase`, `osDir`, `osExt`, `osClean`, `osIsAbs` +* [Flow Control Functions](flow\_control.md): `fail` +* Advanced Functions + * [UUID Functions](uuid.md): `uuidv4` + * [OS Functions](os.md): `env`, `expandenv` + * [Version Comparison Functions](semver.md): `semver`, `semverCompare` + * [Reflection](reflection.md): `typeOf`, `kindIs`, `typeIsLike`, etc. + * [Cryptographic and Security Functions](crypto.md): `derivePassword`, `sha256sum`, `genPrivateKey`, etc. + * [Network](network.md): `getHostByName`