_pkgdown.yml

url: https://posit-dev.github.io/automerge-r/
template:
  package: tidytemplate
  bootstrap: 5
  includes:
    in_header: |
      <script src="https://cdn.jsdelivr.net/gh/posit-dev/supported-by-posit/js/badge.min.js" data-max-height="43" data-light-bg="#666f76" data-light-fg="#f9f9f9"></script>

development:
  mode: auto

reference:
  - title: "Document Lifecycle"
    desc: >
      Create, save, load, and manage Automerge documents
    contents:
      - am_create
      - am_load
      - am_save
      - am_fork
      - am_merge
      - am_commit
      - am_rollback
      - am_close
      - am_clone
      - am_equal
      - am_pending_ops
      - am_commit_empty
      - am_save_incremental
      - am_load_incremental

  - title: "Actor Management"
    desc: >
      Get and set actor IDs
    contents:
      - am_get_actor
      - am_get_actor_hex
      - am_set_actor

  - title: "Object Operations"
    desc: >
      Create and manipulate maps, lists, and nested objects
    contents:
      - am_put
      - am_get
      - am_delete
      - am_insert
      - am_keys
      - am_values
      - am_length
      - am_items
      - am_list_range
      - am_map_range
      - am_list_get_all
      - am_map_get_all

  - title: "Text Operations"
    desc: >
      Work with collaborative text objects
    contents:
      - am_text
      - am_text_content
      - am_text_splice
      - am_text_update
      - as.character.am_text

  - title: "Counters"
    desc: >
      Create and increment CRDT counters
    contents:
      - am_counter
      - am_counter_increment

  - title: "Cursors and Marks"
    desc: >
      Stable positions, text formatting, and cursor serialization
    contents:
      - am_cursor
      - am_cursor_position
      - am_cursor_to_bytes
      - am_cursor_from_bytes
      - am_cursor_to_string
      - am_cursor_from_string
      - am_cursor_equal
      - am_mark
      - am_mark_clear
      - am_marks
      - am_marks_at

  - title: "Synchronization"
    desc: >
      Sync documents across peers
    contents:
      - am_sync
      - am_sync_state
      - am_sync_encode
      - am_sync_decode
      - am_sync_state_encode
      - am_sync_state_decode

  - title: "History and Changes"
    desc: >
      Track document history and inspect changes
    contents:
      - am_get_heads
      - am_get_changes
      - am_apply_changes
      - am_get_last_local_change
      - am_get_change_by_hash
      - am_get_changes_added
      - am_change_from_bytes
      - am_change_to_bytes
      - am_change_hash
      - am_change_message
      - am_change_time
      - am_change_actor_id
      - am_change_seq
      - am_change_deps
      - am_change_size
      - am_get_missing_deps
      - am_load_changes

  - title: "Type Constructors"
    desc: >
      Explicit type constructors for objects
    contents:
      - am_list
      - am_map
      - am_uint64

  - title: "Path-Based Access"
    desc: >
      Navigate deep nested structures
    contents:
      - am_get_path
      - am_put_path
      - am_delete_path

  - title: "Conversion Helpers"
    desc: >
      Convert between R lists and Automerge documents
    contents:
      - as_automerge
      - from_automerge

  - title: "Constants"
    desc: >
      Package constants and enumerations
    contents:
      - automerge-constants
      - AM_ROOT
      - AM_OBJ_TYPE_LIST
      - AM_OBJ_TYPE_MAP
      - AM_OBJ_TYPE_TEXT
      - AM_MARK_EXPAND_NONE
      - AM_MARK_EXPAND_BEFORE
      - AM_MARK_EXPAND_AFTER
      - AM_MARK_EXPAND_BOTH

  - title: "S3 Methods"
    desc: >
      R methods for Automerge objects
    contents:
      - extract-am_doc
      - replace-am_doc
      - extract-am_object
      - replace-am_object
      - length.am_doc
      - length.am_object
      - names.am_doc
      - names.am_map
      - as.list.am_doc
      - str.am_doc

articles:
  - title: "Getting Started"
    navbar: ~
    contents:
      - automerge
      - quick-reference

  - title: "Guides"
    navbar: ~
    contents:
      - crdt-concepts
      - sync-protocol
      - cross-platform

navbar:
  structure:
    left:  [intro, reference, articles, news]
    right: [search, github]
  components:
    articles:
      text: Articles
      menu:
      - text: Getting Started
        href: articles/automerge.html
      - text: Quick Reference
        href: articles/quick-reference.html
      - text: -------
      - text: CRDT Concepts
        href: articles/crdt-concepts.html
      - text: Sync Protocol
        href: articles/sync-protocol.html
      - text: Cross-Platform Interoperability
        href: articles/cross-platform.html