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 et terminal

Commandes, explications de code source, diff et points de terminaison d'API.

Terminal

Le terminal distingue les commandes, les commentaires et la sortie. Définissez le prompt et comment caractères dans les métadonnées. Le bouton de copie copie les commandes exécutables uniquement. Il ne copie pas les caractères d’invite, les lignes de commentaire complètes, ni la sortie de commande. Définissez title et frame (macos, windows, linux, ou plain) comme métadonnées.

Build the documentation
# Vérifiez le site avant la génération de production.
$ mpress check
Aucun problème trouvé.
$ mpress build --strict
15 pages générées en 24ms.
md
@terminal{title="Build the documentation" frame="macos" prompt="$" comment="#"}
# This line is visible but is not copied.
$ mpress check
No issues found.
@end

Diffs

mpress.yaml
− colorScheme: light− search: false+ colorScheme: system+ search: true

Utilisez la valeur par défaut mode="side-by-side" pour une comparaison en deux colonnes.

Code expliqué

func main() {    site.Build()}

1Le programme commence par un point d'entrée Go classique.

2Un appel transforme l'arborescence de contenu en site statique.

Pointez ou mettez le focus sur une ligne de code numérotée pour ouvrir son explication. Sélectionnez la ligne sur un écran tactile.

Points de terminaison de l’API

POST /v1/builds

Crée une génération de documentation.

Champ Type Obligatoire
ref string oui
strict boolean non

Last updated: