blob: 7027f212d92e98a858e03f42ea746ea460c30d3c (
plain) (
blame)
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
100
101
102
103
104
105
106
107
108
109
110
|
site_name: Atuin CLI Docs
site_url: https://docs.atuin.sh/cli/
repo_name: atuinsh/atuin
repo_url: https://github.com/atuinsh/atuin
edit_uri: edit/main/docs/docs/
theme:
name: material
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.sections
- navigation.expand
- search.suggest
- search.highlight
- content.code.copy
- content.action.edit
- content.action.view
# NOTE: to enable ToC and heading anchor links in local (non-multirepo) development,
# comment out the `multirepo` plugin and all its settings.
# Note that this changes the top-level directory when developing locally
# from `/cli/CLI/` to `/cli/.
plugins:
- search
- multirepo:
imported_repo: true
url: https://github.com/atuinsh/docs
section_name: CLI
paths: ["mkdocs.yml", "docs/index.md", "docs/stylesheets/*"]
yml_file: mkdocs.yml
branch: mkt/docs-migration
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
nav:
- Home: index.md
- Guide:
- Getting Started: guide/getting-started.md
- Installation: guide/installation.md
- Setting up sync: guide/sync.md
- Import existing history: guide/import.md
- Basic usage: guide/basic-usage.md
- Advanced usage: guide/advanced-usage.md
- Shell Integration: guide/shell-integration.md
- AI Agent Hooks: guide/agent-hooks.md
- Deleting history: guide/delete-history.md
- Syncing dotfiles: guide/dotfiles.md
- Theming: guide/theming.md
- Configuration:
- Config: configuration/config.md
- Key Binding: configuration/key-binding.md
- Advanced Key Binding: configuration/advanced-key-binding.md
- Reference:
- config: reference/config.md
- daemon: reference/daemon.md
- doctor: reference/doctor.md
- gen-completions: reference/gen-completions.md
- hex: reference/hex.md
- import: reference/import.md
- info: reference/info.md
- history list: reference/list.md
- history prune: reference/prune.md
- search: reference/search.md
- stats: reference/stats.md
- sync: reference/sync.md
- Self Hosting:
- Server Setup: self-hosting/server-setup.md
- Usage: self-hosting/usage.md
- Docker: self-hosting/docker.md
- Kubernetes: self-hosting/kubernetes.md
- Systemd: self-hosting/systemd.md
- AI:
- Introduction: ai/introduction.md
- Settings: ai/settings.md
- "User-Defined Context": ai/user-context.md
- Skills: ai/skills.md
- "Tools & Permissions": ai/tools-permissions.md
- Known Issues: known-issues.md
- Integrations: integrations.md
- FAQ: faq.md
- Uninstall: uninstall.md
- Sync v2: sync-v2.md
|
