Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • v0.1.0
2 results

mkdocs.yml

Blame
  • mkdocs.yml 2.07 KiB
    # Project information
    site_name: 'Quasseldroid'
    site_description: 'Chat comfortably, everywhere.'
    site_author: 'Janne Koschinski'
    site_url: 'https://quasseldroid.info/docs/'
    
    # Copyright
    copyright: 'Copyright © 2020 Janne Koschinski'
    
    nav:
      - "Overview": index.md
      - "Usage":
        - "FAQ": usage/faq.md
        - "Upgrade Guide": usage/upgrade_guide.md
      - "Protocol":
        - "Overview": protocol/overview.md
        - "Layers":
          - "Framing": protocol/layers/framing.md
          - "Message": protocol/layers/message.md
        - "Serialization":
          - "Features": protocol/serialization/features.md
          - "Primitive Objects": protocol/serialization/primitive_objects.md
          - "Handshake Messages": protocol/serialization/handshake_messages.md
          - "SignalProxy Messages": protocol/serialization/signalproxy_messages.md
          - "SignalProxy Objects": protocol/serialization/signalproxy_objects.md
          - "SignalProxy RPC Calls": protocol/serialization/signalproxy_rpc.md
    
    extra:
      social:
        - type: 'globe'
          link: 'https://quasseldroid.info/'
        - type: 'git'
          link: 'https://git.kuschku.de/justjanne/quasseldroid-ng'
    
    theme:
      name: 'material'
      custom_dir: 'theme'
      palette:
        primary: 'brand'
        accent: 'brand'
      logo: 'assets/logo.svg'
      feature:
        tabs: true
      favicon: 'favicon.png'
    
    extra_css:
      - assets/katex.min.css
      - assets/contrib/copy-tex.min.css
      - assets/palette.min.css
      - assets/formatting.css
      - assets/application.css
    extra_javascript:
      - assets/katex.min.js
      - assets/contrib/copy-tex.min.js
      - assets/contrib/auto-render.min.js
      - assets/script.js
    markdown_extensions:
      - admonition
      - codehilite:
          linenums: true
      - footnotes
      - toc:
          permalink: true
      #  - pymdownx.arithmatex
      - pymdownx.betterem:
          smart_enable: all
      - pymdownx.caret
      - pymdownx.critic
      - pymdownx.details
      - pymdownx.emoji: