mkdocs.yml.tpl

site_name: Cozy Developer Documentation
docs_dir: src
site_url: https://docs.cozy.io/
site_dir: docs/en
site_favicon: img/favicon.png
repo_url: https://github.com/cozy/
edit_uri: cozy.github.io/edit/dev/src
site_description: Cozy documentation
site_author: CozyCloud - https://cozy.io
copyright: '<a href="/en/privacy">privacy</a>'
extra_css:
- css/extra.css
extra_javascript:
- extra.js
nav:
- Home: index.md
- Tutorials:
  - Create Your Application: tutorials/app.md
  - Develop a Connector:
    - Introduction: tutorials/konnector/index.md
    - Basic structure: tutorials/konnector/getting-started.md
    - Scrape data: tutorials/konnector/scrape-data.md
    - Save data: tutorials/konnector/save-data.md
    - Package your connector: tutorials/konnector/packaging.md
  - Develop a Client-Side Connector:
    - Introduction: tutorials/client-side-konnector/index.md
    - Installation: tutorials/client-side-konnector/installation.md
    - CliSK Creation: tutorials/client-side-konnector/clisk-creation.md
    - Library Documentation: tutorials/client-side-konnector/clisk-lib-doc.md
    - Troubleshooting: tutorials/client-side-konnector/troubleshooting.md
    - Best Practice: tutorials/client-side-konnector/best-practice.md
    - Contributions: tutorials/client-side-konnector/contributions.md
    - Community: tutorials/client-side-konnector/community.md
    - Additional Ressources: tutorials/client-side-konnector/additional-ressources.md
  - Manipulate data:
    - Introduction: tutorials/data/index.md
    - Queries: tutorials/data/queries.md
    - PouchDB: tutorials/data/pouchdb.md
    - DocTypes: tutorials/data/doctypes.md
    - Qualification: tutorials/data/qualification.md
    - Advanced: tutorials/data/advanced.md
  - Translate Apps: tutorials/translate/index.md
  - Self-Hosting:
    - Introduction: tutorials/selfhosting/index.md
    - Running inside Docker: tutorials/selfhosting/docker/index.md
    - Traditional installation:
      - Requirements:
        - What you need: tutorials/selfhosting/requirements/index.md
        - Installing CouchDB: tutorials/selfhosting/requirements/couchdb.md
        - Installing NodeJS: tutorials/selfhosting/requirements/nodejs.md
      - Installing cozy-stack:
        - Introduction: tutorials/selfhosting/install/index.md
        - From precompiled package: tutorials/selfhosting/install/package.md
        - From sources: tutorials/selfhosting/install/sources.md
      - Finalize installation:
        - Nginx and certificates: tutorials/selfhosting/finalize/nginx.md
        - Using Apache instead of Nginx: tutorials/selfhosting/finalize/apache.md
        - Create first instance: tutorials/selfhosting/finalize/create_instance.md
      - Administration:
        - Index: tutorials/selfhosting/administration/index.md
        - Create more instances: tutorials/selfhosting/administration/more_instances.md
        - Upgrade cozy-stack: tutorials/selfhosting/administration/upgrade.md
        - Configure mail sending: tutorials/selfhosting//administration/mail.md
        - Online edition of office documents: tutorials/selfhosting/administration/office.md
- How-to:
  - Dev:
    - Run an App in a Cozy using Docker: howTos/dev/runCozyDocker.md
    - Develop a service from your application: howTos/dev/services.md
    - Use Hot Module Replacement in Your App: howTos/dev/hmr.md
    - Make a Mobile App Using Cordova: howTos/dev/cordova.md
    - Connect a Mobile App to Your Local Stack: howTos/dev/connect-mobile-app-local-stack.md
    - Run Connectors With a Local cozy-stack: howTos/dev/run-connectors-on-local-cozy-stack.md
    - Send and Receive E-mails in Development: howTos/dev/sendmail.md
    - Our Front-End Git Flow: references/git-flow.md
    - Technical introduction to the Cozy platform: references/tech-intro.md
  - Synchronize:
    - Install Cozy Drive on GNU/Linux: howTos/sync/linux.md
- Libraries:
  - Develop an application:
    - Access data (client): <cozy-client>
    - Build the user interface (ui): <cozy-ui>
    - Define data (doctypes): <cozy-doctypes>
    - Realtime data (realtime): <cozy-realtime>
    - Native devices (device-helper): <cozy-device-helper>
  - Develop a konnector: <cozy-konnector-libs>
  - Publish on the store (app-publish): <cozy-app-publish>
  - Send notifications (cozy-notifications): <cozy-notifications>
  - Dev tools:
    - Babel preset: <babel-preset-cozy-app>
    - Commitlint: <commitlint-config-cozy>
    - ESLint: <eslint-config-cozy-app>
    - ACH: <ach>
  - Advanced:
    - Stack server: <cozy-stack>
    - Registry server: <cozy-apps-registry>
- Projects:
  - Documentations: projects/index.md
  - Cozy Desktop: <cozy-desktop>
theme:
  custom_dir: cozy-theme
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    logo: material/cloud
  font:
    text: Lato
    code: Ubuntu Mono
  features:
    - navigation.tabs
    - navigation.top
    - content.code.copy
markdown_extensions:
- admonition
- pymdownx.highlight
- pymdownx.superfences
- footnotes
- meta
- sane_lists
- smarty
- toc:
    permalink: true
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra: {}
plugins:
    - search:
        separator: '[\s\-\.]+'
    - exclude-search:
        exclude:
          - cozy-stack/archives/*