mkdocs.yml

# metadata
site_name: ldap2pg documentation
site_description: Synchronise Postgres roles from LDAP directory
site_author: Dalibo Labs
site_url: https://ldap2pg.readthedocs.io/
copyright: © Dalibo 2017-2022
repo_name: dalibo/ldap2pg
repo_url: https://github.com/dalibo/ldap2pg

theme:
  favicon: img/logo-80.png
  logo: img/logo-white.png
  name: material
  features:
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.suggest
  - search.highlight

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/dalibo/ldap2pg
  - icon: fontawesome/brands/docker
    link: https://hub.docker.com/r/dalibo/ldap2pg
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/DaliboLabs
  - icon: fontawesome/brands/mastodon
    link: https://mastodon.online/@dalibo

extra_css:
- ldap2pg.css

nav:
- Home: index.md
- Installation: install.md
- Configuration:
  - CLI: cli.md
  - ldap2pg.yml: config.md
  - Inspecting Cluster: postgres.md
  - Managing Roles: roles.md
  - Searching Directory: ldap.md
  - Managing Privileges: privileges.md
  - Builtins Privileges: builtins.md
- Cookbook: cookbook.md
- Changelog: changelog.md
- Hacking: hacking.md

site_dir: dist/docs/

# Markdown settings
markdown_extensions:
- admonition
- attr_list
- sane_lists
- smarty
- toc:
    permalink: yes
- wikilinks
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences


plugins:
- search:
    # From material docs: word, symbols and version.
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- exclude:
    glob:
    # make docs/builtins.md produces a .tmp.
    # Exclude it to avoid mkdocs serve to fail with a file not found.
    - "*.tmp"