mkdocs.yml

site_name: Clikt
repo_name: Clikt
repo_url: https://github.com/ajalt/clikt
site_description: "Clikt: Multiplatform command line parser for Kotlin"
site_author: AJ Alt
remote_branch: gh-pages

copyright: 'Copyright © 2018 AJ Alt'

theme:
  name: 'material'
  logo: img/wordmark_small.svg
  favicon: img/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: 'deep purple'
      accent: 'deep purple'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: 'deep purple'
      accent: 'deep orange'
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

extra_css:
  - 'css/extra.css'

markdown_extensions:
  - smarty
  - codehilite:
      guess_lang: false
  - footnotes
  - meta
  - toc:
      permalink: true
  - admonition
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - admonition

validation:
  nav:
    # nav links like `foo/#anchor` work, but are incorrectly flagged as broken
    not_found: ignore

nav:
  - 'Quickstart':
      - 'Basic Concepts': quickstart.md
      - 'Printing to Stdout and Stderr': quickstart/#printing-to-stdout-and-stderr
      - 'Nesting Commands': quickstart/#nesting-commands
      - 'Adding Parameters': quickstart/#adding-parameters
      - 'Developing Command Line Applications With Gradle': quickstart/#developing-command-line-applications-with-gradle
  - 'Why Clikt?':
      - 'Why not a Kotlin library like kotlin-argparser or kotlinx.cli?': whyclikt.md
      - 'Why not a Java library like JCommander?': whyclikt/#why-not-a-java-library-like-jcommander
  - 'Parameters':
      - 'Differences': parameters.md
      - 'Parameter Names': parameters/#parameter-names
      - 'Parameter Types': parameters/#parameter-types
      - 'Built-In Types': parameters/#built-in-types
      - 'Custom Types': parameters/#custom-types
      - 'Parameter Validation': parameters/#parameter-validation
  - 'Options':
      - 'Basic Options': options.md
      - 'Option Names': options/#option-names
      - 'Customizing Options': options/#customizing-options
      - 'Multi Value Options': options/#multi-value-options
      - 'Multiple Options': options/#multiple-options
      - 'Key-Value and Map Options': options/#key-value-and-map-options
      - 'Boolean Flag Options': options/#boolean-flag-options
      - 'Counted Flag Options': options/#counted-flag-options
      - 'Feature Switch Flags': options/#feature-switch-flags
      - 'Choice Options': options/#choice-options
      - 'Mutually Exclusive Option Groups': options/#mutually-exclusive-option-groups
      - 'Co-Occurring Option Groups': options/#co-occurring-option-groups
      - 'Choice and Switch Options With Groups': options/#choice-and-switch-options-with-groups
      - 'Number Options Without a Name': options/#number-options-without-a-name
      - 'Prompting For Input': options/#prompting-for-input
      - 'Password Prompts': options/#password-prompts
      - 'Eager Options': options/#eager-options
      - 'Deprecating Options': options/#deprecating-options
      - 'Unknown Options': options/#unknown-options
      - 'Values From Environment Variables': options/#values-from-environment-variables
      - 'Values from Configuration Files': options/#values-from-configuration-files
      - 'Windows and Java-Style Option Prefixes': options/#windows-and-java-style-option-prefixes
      - 'Option Transformation Order': options/#option-transformation-order
  - 'Arguments':
      - 'Basic Arguments': arguments.md
      - 'Variadic Arguments': arguments/#variadic-arguments
      - 'Option-Like Arguments ("--")': arguments/#option-like-arguments-using-
  - 'Commands':
      - 'Executing Nested Commands': commands.md
      - 'Customizing Command Name': commands/#customizing-command-name
      - 'Passing Parameters': commands/#passing-parameters
      - 'Nested Handling And Contexts': commands/#nested-handling-and-contexts
      - 'Running Parent Command Without Children': commands/#running-parent-command-without-children
      - 'Customizing Contexts': commands/#customizing-contexts
      - 'Printing the Help Message When No Arguments Are Given': commands/#printing-the-help-message-when-no-arguments-are-given
      - 'Warnings and Other Messages': commands/#warnings-and-other-messages
      - 'Chaining and Repeating Subcommands': commands/#chaining-and-repeating-subcommands
  - 'Documenting Scripts':
      - 'Help Texts': documenting.md
      - 'Preformatting Paragraphs': documenting/#preformatting-paragraphs
      - 'Manual Line Breaks': documenting/#manual-line-breaks
      - 'Subcommand Short Help': documenting/#subcommand-short-help
      - 'Help Option Customization': documenting/#help-option-customization
      - 'Default Values in Help': documenting/#default-values-in-help
      - 'Required Options in Help': documenting/#required-options-in-help
      - 'Grouping Options in Help': documenting/#grouping-options-in-help
      - 'Suggesting Corrections for Mistyped Parameters': documenting/#suggesting-corrections-for-mistyped-parameters
      - 'Localization': documenting/#localization
  - 'Advanced Patterns':
      - 'Common Options With Subcommands': advanced.md
      - 'Command Aliases': advanced/#command-aliases
      - 'Token Normalization': advanced/#token-normalization
      - 'Replacing stdin and stdout': advanced/#replacing-stdin-and-stdout
      - 'Argument Files ("@-files")': advanced/#command-line-argument-files-files
      - 'Managing Shared Resources': advanced/#managing-shared-resources
      - 'Custom exit status codes': advanced/#custom-exit-status-codes
      - 'Custom run function signature': advanced/#custom-run-function-signature
      - 'Custom run behavior': advanced/#custom-run-behavior
      - 'Multiplatform Support': advanced/#multiplatform-support
  - 'Testing':
      - 'Testing Your Commands': testing.md
      - 'Testing Environment Variables': testing/#testing-environment-variables
      - 'Custom Testing': testing/#custom-testing
  - 'Utilities':
      - 'Launching Editors': utilities.md
      - 'Input Prompts': utilities/#input-prompts
      - 'Confirmation Prompts': utilities/#confirmation-prompts
  - 'Shell Completion':
      - 'Supported Functionality': autocomplete.md
      - 'Enabling Completion': autocomplete/#enabling-completion
      - 'Customizing Completions': autocomplete/#customizing-completions
      - 'Limitations': autocomplete/#limitations
  - 'Exception Handling':
      - 'Where are Exceptions Handled?': exceptions.md
      - 'Handling Exceptions Manually': exceptions/#handling-exceptions-manually
      - 'Which Exceptions Exist?': exceptions/#which-exceptions-exist
  - 'API reference':
      - 'Commands and Exceptions': api/clikt/com.github.ajalt.clikt.core/
      - 'Options': api/clikt/com.github.ajalt.clikt.parameters.options/
      - 'Arguments': api/clikt/com.github.ajalt.clikt.parameters.arguments/
      - 'Parameter Type Conversions': api/clikt/com.github.ajalt.clikt.parameters.types/
      - 'Output Formatting': api/clikt/com.github.ajalt.clikt.output/
      - 'All Modules': api/clikt/
  - 'Releases':
    - 'Change Log': changelog.md
    - 'Upgrading to Newer Releases': migration.md