secrets-py/mkdocs.yml at develop · edvm/secrets-py · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
site_name: Top secret documentation
repo_url: https://github.com/edvm/secrets-py.git
site_url: https://edvm.github.io/secrets-py/
site_description: topsecret
site_author: Emiliano Dalla Verde Marcozzi
edit_uri: edit/main/docs/
repo_name: edvm/secrets-py
copyright: Maintained by <a href="https://github.com/edvm/">edvm</a>.

nav:
  - Home: index.md
  - Encryption:
    - AES cipher: infra/cipher/aes.md
    - Encryption service: services/encryption.md
  - Storage:
    - In memory (for dev): infra/storage/inmem.md
  - Delivery:
    - Rest API: adapters/webapi.md
  - Domain:
    - Secrets: domain.md

docs_dir: docs-md
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["topsecret"]
theme:
  name: material
  feature:
    tabs: true
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/edvm/topsecret
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/topsecret

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true