Skip to content

Commit 6cff282

Browse files
xavierogxavierog
committed
Add mkdocs-based documentation.
The idea is to replace Documentation.md with an mkdocs-generated website at https://moulti.run/
1 parent 8173771 commit 6cff282

File tree

250 files changed

+5033
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

250 files changed

+5033
-1
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ venv.bak/
157157

158158
# mkdocs documentation
159159
/site
160+
/doc/docs/assets/
160161

161162
# mypy
162163
.mypy_cache/

‎doc/assets/asciicast/HOWTO.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# demo-debian-upgrade.cast
2+
3+
asciinema rec --title='Moulti demo: Debian upgrade' --cols=128 --rows=42 -c 'podman run -it moulti-demo'
4+
5+
1. Click "Yes, upgrade"
6+
2. Click "apt full-upgrade -y" to expand it:
7+
2.1. Press Home
8+
2.2. Grab the slider and scroll down to the bottom
9+
3. Click "Collapse all"
10+
4. Click "Expand all"
11+
5. Grab the slider and scroll down to the bottom

‎doc/assets/asciicast/demo-debian-upgrade.cast.xz

39.4 KB
Binary file not shown.

‎doc/assets/images/100x11-question/0-instance.properties.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"command": "set",
3+
"title": "Moulti",
4+
"progress_bar": false,
5+
"progress_target": null,
6+
"progress": 0.0,
7+
"step_position": "top",
8+
"step_direction": "down"
9+
}

‎doc/assets/images/100x11-question/1-my_third_question.properties.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"command": "question",
3+
"action": "add",
4+
"id": "my_third_question",
5+
"classes": "standard",
6+
"title": "My third question with Moulti",
7+
"scroll_on_activity": false,
8+
"collapsed": false,
9+
"top_text": "",
10+
"bottom_text": "I live on the second floor",
11+
"text": "What is your name?",
12+
"placeholder": "Enter your name in this input field, or click a button",
13+
"value": "Luka",
14+
"password": false,
15+
"max_length": 0,
16+
"restrict": "",
17+
"button": [
18+
[
19+
"My name is Alice",
20+
"default",
21+
"Alice"
22+
],
23+
[
24+
"My name is Bob",
25+
"default",
26+
"Bob"
27+
],
28+
[
29+
"My name is {input}",
30+
"success",
31+
"Neither, use input"
32+
]
33+
]
34+
}

‎doc/assets/images/100x11-question/input

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env bash
2+
sleep .5
3+
printf 
4+
sleep .2
5+
printf 

‎doc/assets/images/100x11-question/moulti.css

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#header, Footer { display: none; }

‎doc/assets/images/100x13-moulti-run-output-discard/00-instance.properties.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"command": "set",
3+
"title": "Moulti",
4+
"progress_bar": false,
5+
"progress_target": null,
6+
"progress": 0.0,
7+
"step_position": "top",
8+
"step_direction": "down"
9+
}

‎doc/assets/images/100x13-moulti-run-output-discard/01-1.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "1",
5+
"classes": "standard",
6+
"title": "22:20:01: step #1",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/03-2.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "2",
5+
"classes": "standard",
6+
"title": "22:20:02: step #2",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/04-3.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "3",
5+
"classes": "standard",
6+
"title": "22:20:03: step #3",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/05-4.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "4",
5+
"classes": "standard",
6+
"title": "22:20:04: step #4",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/06-5.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "5",
5+
"classes": "standard",
6+
"title": "22:20:05: step #5",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/07-6.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "6",
5+
"classes": "standard",
6+
"title": "22:20:06: step #6",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/08-7.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "7",
5+
"classes": "standard",
6+
"title": "22:20:07: step #7",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/09-8.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "8",
5+
"classes": "standard",
6+
"title": "22:20:08: step #8",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/10-9.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "9",
5+
"classes": "standard",
6+
"title": "22:20:09: step #9",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-discard/11-10.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "10",
5+
"classes": "standard",
6+
"title": "22:20:10: step #10",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/00-instance.properties.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"command": "set",
3+
"title": "Moulti",
4+
"progress_bar": false,
5+
"progress_target": null,
6+
"progress": 0.0,
7+
"step_position": "top",
8+
"step_direction": "down"
9+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/01-1.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "1",
5+
"classes": "standard",
6+
"title": "22:20:01: step #1",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/03-2.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "2",
5+
"classes": "standard",
6+
"title": "22:20:02: step #2",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/04-3.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "3",
5+
"classes": "standard",
6+
"title": "22:20:03: step #3",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/05-4.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "4",
5+
"classes": "standard",
6+
"title": "22:20:04: step #4",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/06-5.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "5",
5+
"classes": "standard",
6+
"title": "22:20:05: step #5",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/07-6.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "6",
5+
"classes": "standard",
6+
"title": "22:20:06: step #6",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/08-7.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "7",
5+
"classes": "standard",
6+
"title": "22:20:07: step #7",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/09-8.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "8",
5+
"classes": "standard",
6+
"title": "22:20:08: step #8",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/10-9.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "9",
5+
"classes": "standard",
6+
"title": "22:20:09: step #9",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

‎doc/assets/images/100x13-moulti-run-output-ignore/11-10.properties.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"command": "step",
3+
"action": "add",
4+
"id": "10",
5+
"classes": "standard",
6+
"title": "22:20:10: step #10",
7+
"scroll_on_activity": false,
8+
"collapsed": true,
9+
"top_text": "",
10+
"bottom_text": "",
11+
"auto_scroll": true,
12+
"min_height": 1,
13+
"max_height": 25
14+
}

0 commit comments

Comments
 (0)