mkdocs.yml

site_name: Go Utils
site_description: Functional programming utilities for Go 1.21+ - complementary with stdlib slices, maps, and cmp
site_url: https://goldziher.github.io/go-utils/
site_author: Na'aman Hirschfeld
repo_name: Goldziher/go-utils
repo_url: https://github.com/Goldziher/go-utils
edit_uri: edit/main/docs/
copyright: Copyright © 2023-2025 Na'aman Hirschfeld

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: lime
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
  language: en

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      linenums: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true
      toc_depth: 3

plugins:
  - search
  - social
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Goldziher/go-utils
    - icon: fontawesome/brands/golang
      link: https://pkg.go.dev/github.com/Goldziher/go-utils

extra_css:
  - css/extra.css

nav:
  - Home: index.md
  - Packages:
      - sliceutils:
          - Overview: sliceutils/index.md
          - Functional Operations:
              - Filter: sliceutils/filter.md
              - Map: sliceutils/map.md
              - Reduce: sliceutils/reduce.md
              - ForEach: sliceutils/forEach.md
          - Search Operations:
              - Find: sliceutils/find.md
              - FindIndex: sliceutils/findIndex.md
              - FindIndexOf: sliceutils/findIndexOf.md
              - FindIndexes: sliceutils/findIndexes.md
              - FindIndexesOf: sliceutils/findIndexesOf.md
              - FindLastIndex: sliceutils/findLastIndex.md
              - FindLastIndexOf: sliceutils/findLastIndexOf.md
              - Includes: sliceutils/includes.md
          - Predicates:
              - Some: sliceutils/some.md
              - Every: sliceutils/every.md
          - Set Operations:
              - Merge: sliceutils/merge.md
              - Union: sliceutils/union.md
              - Intersection: sliceutils/intersection.md
              - Difference: sliceutils/difference.md
              - Unique: sliceutils/unique.md
          - Grouping & Analysis:
              - GroupBy: sliceutils/groupBy.md
              - Partition: sliceutils/partition.md
              - DistinctBy: sliceutils/distinctBy.md
              - CountBy: sliceutils/countBy.md
          - Selection:
              - Insert: sliceutils/insert.md
              - Take: sliceutils/take.md
              - Skip: sliceutils/skip.md
              - TakeLast: sliceutils/takeLast.md
              - SkipLast: sliceutils/skipLast.md
              - TakeWhile: sliceutils/takeWhile.md
              - SkipWhile: sliceutils/skipWhile.md
          - Aggregation:
              - MinBy: sliceutils/minBy.md
              - MaxBy: sliceutils/maxBy.md
          - Accessors:
              - Head: sliceutils/head.md
              - Tail: sliceutils/tail.md
              - Last: sliceutils/last.md
              - Initial: sliceutils/initial.md
          - Transformations:
              - Reverse: sliceutils/reverse.md
              - Flatten: sliceutils/flatten.md
              - FlatMap: sliceutils/flatMap.md
              - Chunk: sliceutils/chunk.md
              - Pluck: sliceutils/pluck.md
          - Utilities:
              - Copy: sliceutils/copy.md
              - Remove: sliceutils/remove.md
              - EnsureUniqueAndAppend: sliceutils/ensureUniqueAndAppend.md
              - Sum: sliceutils/sum.md
              - Compact: sliceutils/compact.md
              - Windows: sliceutils/windows.md
      - maputils:
          - Overview: maputils/index.md
          - Basic Operations:
              - Keys: maputils/keys.md
              - Values: maputils/values.md
              - Filter: maputils/filter.md
              - ForEach: maputils/forEach.md
              - Merge: maputils/merge.md
              - Drop: maputils/drop.md
              - Copy: maputils/copy.md
          - Transformations:
              - Map: maputils/map.md
              - MapKeys: maputils/mapKeys.md
              - Invert: maputils/invert.md
          - Selection:
              - Pick: maputils/pick.md
              - Omit: maputils/omit.md
              - Has: maputils/has.md
              - Get: maputils/get.md
          - Conversions:
              - ToEntries: maputils/toEntries.md
              - FromEntries: maputils/fromEntries.md
          - Grouping:
              - GroupBy: maputils/groupBy.md
      - mathutils:
          - Overview: mathutils/index.md
          - Comparison:
              - Clamp: mathutils/clamp.md
              - InRange: mathutils/inRange.md
          - Arithmetic:
              - Abs: mathutils/abs.md
              - Average: mathutils/average.md
              - Gcd: mathutils/gcd.md
              - Lcm: mathutils/lcm.md
          - Number Theory:
              - IsPrime: mathutils/isPrime.md
      - ptrutils:
          - Overview: ptrutils/index.md
          - Creation:
              - To: ptrutils/to.md
              - ToSlice: ptrutils/toSlice.md
              - ToPointerSlice: ptrutils/toPointerSlice.md
          - Dereferencing:
              - Deref: ptrutils/deref.md
              - DerefSlice: ptrutils/derefSlice.md
          - Utilities:
              - Equal: ptrutils/equal.md
              - Coalesce: ptrutils/coalesce.md
              - IsNil: ptrutils/isNil.md
              - NonNilSlice: ptrutils/nonNilSlice.md
      - excutils:
          - Overview: excutils/index.md
          - Panic Handling:
              - Must: excutils/must.md
              - MustResult: excutils/mustResult.md
              - Try: excutils/try.md
              - Catch: excutils/catch.md
              - RecoverWithValue: excutils/recoverWithValue.md
          - Error Handling:
              - IgnoreErr: excutils/ignoreErr.md
              - FirstErr: excutils/firstErr.md
              - AllErr: excutils/allErr.md
              - ReturnAnyErr: excutils/returnAnyErr.md
          - Validation:
              - ReturnNotNil: excutils/returnNotNil.md
              - MustNotNil: excutils/mustNotNil.md
          - Retry Logic:
              - Retry: excutils/retry.md
              - RetryWithResult: excutils/retryWithResult.md
      - stringutils:
          - Overview: stringutils/index.md
          - Stringify: stringutils/stringify.md
          - Capitalize: stringutils/capitalize.md
          - PadLeft: stringutils/padLeft.md
          - PadRight: stringutils/padRight.md
      - structutils:
          - Overview: structutils/index.md
          - ToMap: structutils/toMap.md
          - ForEach: structutils/forEach.md
      - dateutils:
          - Overview: dateutils/index.md
          - Floor: dateutils/floor.md
          - Ceil: dateutils/ceil.md
          - BeforeOrEqual: dateutils/beforeorequal.md
          - AfterOrEqual: dateutils/afterorequal.md
          - Overlap: dateutils/overlap.md
      - urlutils:
          - Overview: urlutils/index.md
          - QueryStringifyMap: urlutils/queryStringifyMap.md
          - QueryStringifyStruct: urlutils/queryStringifyStruct.md
  - Contributing: contributing.md