Turbo MoonBit — documentation

 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

# Turbo MoonBit — documentation

Turbo MoonBit is a Turbo C-style editor for MoonBit: a full-screen terminal IDE with menus, movable windows, syntax colouring for nine languages, themes, completion from `moon-lsp`, shell windows, per-project settings, a project tree, snippets, and the MoonBit toolchain a menu away.

This documentation follows the [Diátaxis](https://diataxis.fr) method. Four kinds of page, four different needs — go to the one that matches what you want right now.

| I want to… | Go to |
| --- | --- |
| **learn** the editor by using it | [Tutorials](tutorials/) |
| **do** something specific | [How-to guides](how-to/) |
| **look up** an exact detail | [Reference](reference/) |
| **understand** how and why it works | [Explanation](explanation/) |

## Tutorials — learning by doing

- [Your first MoonBit program in Turbo MoonBit](tutorials/getting-started.md) — install it, write a program, format it, run it, break it and see the editor say where.
- [Demo projects](../../demos/) — three MoonBit projects to open in the editor once you have it: a small one, one with a library and tests, and a tour of every construct the scanner colours.

## How-to guides — recipes for a task

- [How to install and build Turbo MoonBit](how-to/install.md)
- [How to install the MoonBit toolchain](how-to/install-the-moonbit-toolchain.md)
- [How to run the tests](how-to/run-the-tests.md)
- [How to enable MoonBit completion](how-to/enable-completion.md)
- [How to write your own theme](how-to/write-a-theme.md)
- [How to move around a file](how-to/navigate-code.md)
- [How to ask what the code means](how-to/ask-about-code.md)
- [How to run shell commands without leaving the editor](how-to/use-a-terminal.md)
- [How to give a project its own settings](how-to/configure-a-project.md)
- [How to browse a project and open files from a tree](how-to/browse-a-project.md)
- [How to insert snippets from a menu](how-to/use-snippets.md)
- [How to run moon commands from the editor](how-to/run-moon-commands.md)
- [How to make a release](how-to/make-a-release.md)
- [How to talk to a coding agent from the editor](how-to/talk-to-an-agent.md)

## Reference — the exact details

- [Command line](reference/cli.md)
- [Keyboard](reference/keyboard.md)
- [Menus](reference/menus.md)
- [Theme file format](reference/themes.md)
- [Terminal windows](reference/terminal.md)
- [Project settings](reference/project-settings.md)
- [Project tree](reference/project-tree.md)
- [Languages coloured](reference/languages.md)
- [Snippets](reference/snippets.md)
- [MoonBit tools](reference/moonbit-tools.md)
- [The version number](reference/versioning.md)
- [Agents and ACP](reference/acp.md)

## Explanation — understanding

- [Architecture](explanation/architecture.md)
- [Design decisions](explanation/design-decisions.md)
- [Colouring and completion](explanation/colouring-and-completion.md)
- [Terminal windows](explanation/terminal-windows.md)
- [Project settings](explanation/project-settings.md)
- [Project tree](explanation/project-tree.md)
- [Snippets](explanation/snippets.md)
- [MoonBit tools](explanation/moonbit-tools.md)
- [Agent windows](explanation/agent-windows.md)