Skip to content

Commit 43590e0

Browse files
committed
Discard Documentation.md.
1 parent 6cff282 commit 43590e0

16 files changed

+47
-1327
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Although Moulti's Python packages, modules and functions are obviously available
88

99
## Unreleased
1010

11+
### Changed
12+
13+
- [moulti.run](https://moulti.run/) is the new official documentation. It replaces `Documentation.md`.
14+
1115
### Fixed
1216

1317
- Running `moulti` without any argument used to crash since v1.30.0.

Documentation.md

+2-1,285
Large diffs are not rendered by default.

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ By the way, Moulti can also display man pages and unified diff files (with color
2626

2727
TL;DR: `pipx install moulti; pipx ensurepath`
2828

29-
More details in the [Documentation](Documentation.md#installation)
29+
More details in the [Documentation](https://moulti.run/install/)
3030

3131
## How?
3232

@@ -37,7 +37,7 @@ Synopsis:
3737
3. Fill it: `whatever_your_script_does | moulti pass step_name`
3838
4. Repeat #2 and #3 until your script is done.
3939

40-
Learn how to leverage Moulti by jumping to its [Documentation](Documentation.md).
40+
Learn how to leverage Moulti by jumping to its [Documentation](https://moulti.run/)
4141

4242
## Features
4343

@@ -48,18 +48,18 @@ As shown in the demo, Moulti enables user interactions through **questions**:
4848
![Moulti button question](https://xavier.kindwolf.org/p/moulti/doc/img/moulti-button-question.png?20240218)
4949

5050
Moulti also features:
51-
- text **search**, similar to `less`: [documentation](Documentation.md#text-search)
51+
- text **search**, similar to `less`: [documentation](https://moulti.run/text-search/)
5252
- ability to maximize a single step log, similar to tmux's zoom feature
53-
- a **progress bar**: [documentation](Documentation.md#progress-bar)
54-
- programmatic scrolling: [documentation](Documentation.md#programmatically-scrolling-through-steps)
55-
- an askpass helper named `moulti-askpass`: [documentation](Documentation.md#moulti-run-dealing-with-ssh)
56-
- support for [Ansible playbooks](Documentation.md#moulti-run-dealing-with-ansible), [man pages](Documentation.md#moulti-manpage) and [unified diff](Documentation.md#moulti-diff)
53+
- a **progress bar**: [documentation](https://moulti.run/progressbar/)
54+
- programmatic scrolling: [documentation](https://moulti.run/scrolling/#programmatically-scrolling-through-steps)
55+
- an askpass helper named `moulti-askpass`: [documentation](https://moulti.run/shell-scripting/#ssh)
56+
- support for [Ansible playbooks](https://moulti.run/ansible/), [man pages](https://moulti.run/manpage/) and [unified diff](https://moulti.run/diff/)
5757

5858
When it comes to look and feel, Moulti can be customised:
5959

60-
- through `moulti set`: define whether Moulti steps flow up or down: [documentation](Documentation.md#multiple-ways-to-display-steps)
61-
- through [Textual CSS (TCSS)](https://textual.textualize.io/guide/CSS/): [documentation](Documentation.md#how-to-define-my-own-step-classes-)
62-
- through ANSI themes: [documentation](Documentation.md#appearance-look-and-feel)
60+
- through `moulti set`: define whether Moulti steps flow up or down: [documentation](https://moulti.run/direction-and-position/)
61+
- through [Textual CSS (TCSS)](https://textual.textualize.io/guide/CSS/): [documentation](https://moulti.run/classes/#custom-classes)
62+
- through ANSI themes: [documentation](https://moulti.run/environment-variables/#moulti_ansi)
6363

6464
## Implementation
6565

doc/img/questions-step01.png

-12.3 KB
Binary file not shown.

doc/img/questions-step03.png

-16 KB
Binary file not shown.

doc/img/quickstart-step02.png

-20.7 KB
Binary file not shown.

doc/img/quickstart-step03.png

-24.1 KB
Binary file not shown.

doc/img/quickstart-step04.png

-27 KB
Binary file not shown.

doc/img/quickstart-step05.png

-122 KB
Binary file not shown.

doc/img/quickstart-step06.png

-125 KB
Binary file not shown.

doc/img/quickstart-step07.png

-136 KB
Binary file not shown.

doc/img/quickstart-step08.png

-158 KB
Binary file not shown.

doc/img/quickstart-step09.png

-147 KB
Binary file not shown.

pyproject.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ bsd-ci = [
9292
]
9393

9494
[project.urls]
95-
Homepage = "https://github.com/xavierog/moulti/?tab=readme-ov-file#moulti"
96-
Documentation = "https://github.com/xavierog/moulti/blob/master/Documentation.md"
95+
Homepage = "https://moulti.run/"
96+
Documentation = "https://moulti.run/"
9797
Repository = "https://github.com/xavierog/moulti.git"
9898
Issues = "https://github.com/xavierog/moulti/issues"
9999
Changelog = "https://github.com/xavierog/moulti/blob/master/CHANGELOG.md"

src/moulti/widgets/helpscreen.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ class HelpScreen(ModalScreen):
88
Modal screen presenting the various keybindings available in Moulti.
99
"""
1010

11-
TEXT = """[u]Documentation[/]:
12-
https://github.com/xavierog/moulti/blob/master/Documentation.md
11+
TEXT = """[u]Documentation[/]: https://moulti.run/
1312
1413
[u]Keybindings[/]:
1514
[key]tab[/], [key]shift+tab[/]: next/previous step/component

tests/__snapshots__/test_help_dialog/test_help_dialog.svg

+28-28
Loading

0 commit comments

Comments
 (0)