Skip to content

Commit 504b60a

Browse files
committed
docs: Add tabs
1 parent 57fedd4 commit 504b60a

File tree

2 files changed

+36
-27
lines changed

2 files changed

+36
-27
lines changed

docs/configuration.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,52 @@
11
# Configuration
22

3+
Check all available configs [here](#all-configs) and its default values [here](#default-values).
4+
35
## Ways to configure
46

5-
Check all available configs [here](../src/eca/config.clj#L17).
67
There are 3 ways to configure ECA following this order of priority:
78

8-
### InitializationOptions (convenient for editors)
9+
=== "Global config file"
910

10-
Client editors can pass custom settings when sending the `initialize` request via the `initializationOptions` object:
11+
Convenient for users and multiple projects
1112

12-
```javascript
13-
"initializationOptions": {
14-
"chatBehavior": "agent"
15-
}
16-
```
13+
`~/.config/eca/config.json`
14+
```javascript
15+
{
16+
"chatBehavior": "agent"
17+
}
18+
```
19+
20+
=== "Local Config file"
1721

18-
### Local Config file (convenient for users)
22+
Convenient for users
1923

20-
`.eca/config.json`
21-
```javascript
22-
{
23-
"chatBehavior": "agent"
24-
}
25-
```
24+
`.eca/config.json`
25+
```javascript
26+
{
27+
"chatBehavior": "agent"
28+
}
29+
```
30+
31+
=== "InitializationOptions"
2632

27-
### Global config file (convenient for users and multiple projects)
33+
Convenient for editors
2834

29-
`~/.config/eca/config.json`
30-
```javascript
31-
{
32-
"chatBehavior": "agent"
33-
}
34-
```
35+
Client editors can pass custom settings when sending the `initialize` request via the `initializationOptions` object:
36+
37+
```javascript
38+
"initializationOptions": {
39+
"chatBehavior": "agent"
40+
}
41+
```
3542

36-
### Env Var
43+
=== "Env var"
3744

38-
Via env var during server process spawn:
45+
Via env var during server process spawn:
3946

40-
```bash
41-
ECA_CONFIG='{"myConfig": "my_value"}' eca server
42-
```
47+
```bash
48+
ECA_CONFIG='{"myConfig": "my_value"}' eca server
49+
```
4350

4451
## Models
4552

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ markdown_extensions:
4343
- pymdownx.emoji:
4444
emoji_index: !!python/name:materialx.emoji.twemoji
4545
emoji_generator: !!python/name:materialx.emoji.to_svg
46+
- pymdownx.tabbed:
47+
alternate_style: true
4648

4749
plugins:
4850
- search

0 commit comments

Comments
 (0)