_pkgdown.yml

url: https://hauselin.github.io/ollama-r

home:
    title: Ollama R Library
    description: Run Ollama language models in R.
    sidebar:
      structure: [links, license, community, citation, authors, dev, toc]
      toc:
        depth: 4

navbar:
    structure:
      left: [intro, reference, news]
    components:
      twitter:
        icon: fa-twitter
        href: https://x.com/hauselin
        arial-label: X

template:
  bootstrap: 5
  light-switch: true
  theme: a11y-light
  theme-dark: a11y-dark
  opengraph:
    twitter:
      site: "@hauselin"
      creator: "@hauselin"

reference:
  - title: Ollamar functions

  - subtitle: API endpoints
    desc: Make calls to the Ollama server/API.
    contents:
      - generate
      - chat
      - create
      - list_models
      - show
      - copy
      - delete
      - pull
      - push
      - embed
      - embeddings
      - ps
      - ver

  - subtitle: API helpers
    desc: Work with and extend the Ollama API.
    contents:
      - resp_process
      - ohelp
      - model_avail
      - image_encode_base64
      - test_connection
      - create_request

  - subtitle: Manipulate chat history
    desc: Manipulate chat history for Ollama and other LLM providers.
    contents:
      - create_messages
      - create_message
      - append_message
      - prepend_message
      - delete_message
      - insert_message
      - validate_message
      - validate_messages
      - encode_images_in_messages

  - subtitle: Model options
    desc: Functions to get information about the options available.
    contents:
      - check_option_valid
      - check_options
      - search_options
      - validate_options

  - subtitle: Internal functions and variables
    desc: Functions and variables used internally by the package.
    contents:
      - package_config
      - model_options
      - stream_handler
      - resp_process_stream
      - get_tool_calls