Search
Contribute

Edit this documentation

Translate the documentation or open the complete project on your computer.

Nothing is published until you choose to submit your work.

Code and terminal

Commands, source explanations, diffs, and API endpoints.

Terminal

The terminal distinguishes commands, comments, and output. Set the prompt and comment characters in metadata. The copy button copies executable commands only. It does not copy prompt characters, complete comment lines, or command output. Set title and frame (macos, windows, linux, or plain) as metadata.

Build the documentation
# Check the site before the production build.
$ mpress check
No issues found.
$ mpress build --strict
Built 15 pages in 24ms.
Source
md
@terminal{title="Build the documentation" frame="macos" prompt="$" comment="#"}
# Check the site before the production build.
$ mpress check
No issues found.
$ mpress build --strict
Built 15 pages in 24ms.
@end

Diffs

mpress.yaml
− colorScheme: light− search: false+ colorScheme: system+ search: true
Source
md
@diff{title="mpress.yaml" mode="inline"}
colorScheme: light
search: false
---
colorScheme: system
search: true
@end

Use the default mode="side-by-side" for a two-column comparison.

Explained code

func main() {    site.Build()}

1The program starts with a regular Go entry point.

2One call turns the content tree into the static site.

Source
md
@explained
```go
func main() { // (1)
    site.Build() // (2)
}
```

(1) The program starts with a regular Go entry point.

(2) One call turns the content tree into the static site.
@end

Point to or focus a numbered code line to open its explanation. Select the line on a touch screen.

API endpoints

POST /v1/builds

Creates a documentation build.

Field Type Required
ref string yes
strict boolean no
Source
md
@api{method="POST" path="/v1/builds"}
Creates a documentation build.

| Field | Type | Required |
| --- | --- | --- |
| `ref` | string | yes |
| `strict` | boolean | no |
@end

Last updated: