mkdocs.yml

site_name: GodotSteam
site_url: https://godotsteam.com
site_description: An open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Game Engine.
site_author: GP Garcia | Contributors

copyright: Copyright © 2015-Current | GP Garcia | Contributors

repo_url: https://github.com/GodotSteam/GodotSteam
repo_name: GodotSteam

edit_uri: https://github.com/GodotSteam/GodotSteam-Docs/tree/master/docs/


#################################################
# Navigation
#################################################
nav:
  - Introduction: 'index.md'

  - News:
    - blog/index.md

  - Compiling:
    - How-To Godot 2, 3, 4: 'howto/modules.md'
    - How-To GDExtension: 'howto/gdextension.md'
    - How-To GDNative: 'howto/gdnative.md'
    - How-To Multiplayer Peer: 'howto/multiplayer_peer.md'
    - How-To Server: 'howto/server.md'

  - Repositories: 'https://github.com/GodotSteam/'

  - Classes:
    - Main: 'classes/main.md'
    - Main Server: 'classes/main_server.md'
    - MultiplayerPeer: 'classes/multiplayer_peer.md'
    - App Lists: 'classes/app_lists.md'
    - Apps: 'classes/apps.md'
    - Friends: 'classes/friends.md'
    - Game Search: 'classes/game_search.md'
    - Game Server: 'classes/game_server.md'
    - Game Server Stats: 'classes/game_server_stats.md'
    - HTML Surface: 'classes/html_surface.md'
    - HTTP: 'classes/http.md'
    - Input: 'classes/input.md'
    - Inventory: 'classes/inventory.md'
    - Matchmaking: 'classes/matchmaking.md'
    - Matchmaking Servers: 'classes/matchmaking_servers.md'
    - Music: 'classes/music.md'
    - Music Remote: 'classes/music_remote.md'
    - Networking: 'classes/networking.md'
    - Networking Messages: 'classes/networking_messages.md'
    - Networking Sockets: 'classes/networking_sockets.md'
    - Networking Types: 'classes/networking_types.md'
    - Networking Utils: 'classes/networking_utils.md'
    - Parental Settings: 'classes/parental_settings.md'
    - Parties: 'classes/parties.md'
    - Remote Play: 'classes/remote_play.md'
    - Remote Storage: 'classes/remote_storage.md'
    - Screenshots: 'classes/screenshots.md'
    - Timeline: 'classes/timeline.md'
    - UGC: 'classes/ugc.md'
    - User: 'classes/user.md'
    - User Stats: 'classes/user_stats.md'
    - Utils: 'classes/utils.md'
    - Video: 'classes/video.md'

  - Tutorials:
    - Achievement Icons: 'tutorials/achievement_icons.md'
    - Authentication: 'tutorials/authentication.md'
    - Auto-Matchmaking: 'tutorials/auto_matchmaking.md'
    - Avatars: 'tutorials/avatars.md'
    - C#: 'tutorials/c-sharp.md'
    - Exporting and Shipping: 'tutorials/exporting_shipping.md'
    - Friends' Lobbies: 'tutorials/friends_lobbies.md'
    - Initializing Steam: 'tutorials/initializing.md'
    - Leaderboards: 'tutorials/leaderboards.md'
    - Lobbies: 'tutorials/lobbies.md'
    - Mac Exporting: 'tutorials/mac_export.md'
    - P2P Networking: 'tutorials/p2p.md'
    - Remove Steam: 'tutorials/remove_steam.md'
    - Rich Presence: 'tutorials/rich_presence.md'
    - Stats and Achievements: 'tutorials/stats_achievements.md'
    - Voice: 'tutorials/voice.md'
    - Workshop: 'tutorials/workshop.md'

  - External Resources: 'tutorials/external.md'

  - Common Issues:
    - General: 'issues/common_issues.md'
    - Linux Platform: 'issues/linux_issues.md'
    - Mac Platform: 'issues/mac_issues.md'

  - Games Using GodotSteam:
    - 0 to 9 Games: 'games/games-0-9.md'
    - A Games: 'games/games-a.md'
    - B Games: 'games/games-b.md'
    - C Games: 'games/games-c.md'
    - D Games: 'games/games-d.md'
    - E Games: 'games/games-e.md'
    - F Games: 'games/games-f.md'
    - G Games: 'games/games-g.md'
    - H Games: 'games/games-h.md'
    - I Games: 'games/games-i.md'
    - J Games: 'games/games-j.md'
    - K Games: 'games/games-k.md'
    - L Games: 'games/games-l.md'
    - M Games: 'games/games-m.md'
    - N Games: 'games/games-n.md'
    - O Games: 'games/games-o.md'
    - P Games: 'games/games-p.md'
    - Q Games: 'games/games-q.md'
    - R Games: 'games/games-r.md'
    - S Games: 'games/games-s.md'
    - T Games: 'games/games-t.md'
    - U Games: 'games/games-u.md'
    - V Games: 'games/games-v.md'
    - W Games: 'games/games-w.md'
    - X Games: 'games/games-x.md'
    - Y Games: 'games/games-y.md'
    - Z Games: 'games/games-z.md'

  - Projects:
    - Skillet:
      - Intro: 'projects/skillet/intro.md'
      - Assets: 'projects/skillet/assets.md'
      - Editor: 'projects/skillet/editor.md'
      - Inventory: 'projects/skillet/inventory.md'
      - Workshop: 'projects/skillet/workshop.md'
      - Licenses: 'projects/skillet/licenses.md'
    - General:
      - To-Do: 'https://github.com/orgs/GodotSteam/projects/3'

  - Changes:
    - Godot 4.x: 'changelog/godot4.md'
    - Godot 3.x: 'changelog/godot3.md'
    - Godot 2.x: 'changelog/godot2.md'
    - GDExtension: 'changelog/gdextension.md'
    - GDNative: 'changelog/gdnative.md'
    - Multiplayer Peer: 'changelog/multiplayer_peer.md'
    - Server 3.x: 'changelog/server3.md'
    - Server 4.x: 'changelog/server4.md'
    - Server GDExtension: 'changelog/server_gdextension.md'
    - Server GDNative: 'changelog/server_gdnative.md'
    - Skillet Editor: 'changelog/skillet_editor.md'
    - Skillet Assets: 'changelog/skillet_assets.md'

  - Contributors:
    - Contributing: 'contribute/rules.md'
    - Contributor List: 'contribute/contributors.md'
    - Donating: 'contribute/donations.md'


#################################################
# Theme and extra
#################################################
theme:
  favicon: assets/images/favicon.png
  features:
    - announce.dismiss
    - content.code.copy
    - content.code.select
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
  font:
    text: Roboto
    code: Roboto Mono
  highlightjs: true
  hljs_languages:
    - gdscript
  icon:
    repo: fontawesome/brands/github
  language: en
  logo: assets/images/logo-outlined.png
  name: material
  palette:
    scheme: slate
    primary: custom


extra:
  alternate:
    - name: English
      link: /en/
      lang: env
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GodotSteam/GodotSteam
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.gamedev.place/@godotsteam
    - icon: fontawesome/brands/patreon
      link: https://patreon.com/godotsteam
    - icon: fontawesome/solid/paper-plane
      link: mailto:hello@godotsteam.com
    - icon: fontawesome/brands/twitch
      link: https://www.twitch.tv/godotsteam


#################################################
# Plug-in and Extensions
#################################################
plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - badges

  - blog:
      blog_toc: true
      archive_date_format: MMMM yyyy
      pagination_per_page: 5
#      archive_pagination_per_page: 10

  - social:
      cards_layout_options:
        background_color: "#424242"
        logo: docs/assets/images/godotsteam-steam-icon.png

  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date.created
        as_update: date.updated
      categories:
        - categories
        - tags

  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true


markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - def_list
  - footnotes
  - meta
  - md_in_html
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - tables


extra_css:
  - assets/stylesheets/extra.css