docs/mkdocs.yml at main · atuinsh/docs · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
site_name: Atuin Documentation
site_url: https://docs.atuin.sh
repo_url: https://github.com/atuinsh/atuin
repo_name: atuinsh/atuin

theme:
  name: material
  custom_dir: overrides
  palette:
    - scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - content.action.view

plugins:
  - search
  - multirepo:
      cleanup: false
  - git-revision-date-localized:
      enable_creation_date: true
  - redirects:
      redirect_maps:
        "guide/getting-started.md": "cli/guide/getting-started.md"
        "guide/installation.md": "cli/guide/installation.md"
        "guide/sync.md": "cli/guide/sync.md"
        "guide/import.md": "cli/guide/import.md"
        "guide/basic-usage.md": "cli/guide/basic-usage.md"
        "guide/dotfiles.md": "cli/guide/dotfiles.md"
        "guide/theming.md": "cli/guide/theming.md"
        "configuration/config.md": "cli/configuration/config.md"
        "configuration/key-binding.md": "cli/configuration/key-binding.md"
        "reference/list.md": "cli/reference/list.md"
        "reference/search.md": "cli/reference/search.md"
        "reference/stats.md": "cli/reference/stats.md"
        "reference/doctor.md": "cli/reference/doctor.md"
        "reference/daemon.md": "cli/reference/daemon.md"
        "reference/import.md": "cli/reference/import.md"
        "reference/info.md": "cli/reference/info.md"
        "reference/gen-completions.md": "cli/reference/gen-completions.md"
        "reference/prune.md": "cli/reference/prune.md"
        "reference/sync.md": "cli/reference/sync.md"
        "self-hosting/server-setup.md": "cli/self-hosting/server-setup.md"
        "self-hosting/usage.md": "cli/self-hosting/usage.md"
        "self-hosting/docker.md": "cli/self-hosting/docker.md"
        "self-hosting/kubernetes.md": "cli/self-hosting/kubernetes.md"
        "self-hosting/systemd.md": "cli/self-hosting/systemd.md"
        "known-issues.md": "cli/known-issues.md"
        "integrations.md": "cli/integrations.md"
        "faq.md": "cli/faq.md"
        "uninstall.md": "cli/uninstall.md"
        "sync-v2.md": "cli/sync-v2.md"
        "index.md": "cli/index.md"

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/atuinsh/atuin
    - icon: fontawesome/brands/discord
      link: https://discord.gg/jR3tfchVvW

nav:
  - CLI: "!import https://github.com/atuinsh/atuin?branch=main&docs_dir=docs/docs/*&config=docs/mkdocs.yml"
  - Desktop: "!import https://github.com/atuinsh/desktop?branch=main&docs_dir=docs/docs/*&config=docs/mkdocs.yml"