mirror of https://github.com/docker/cli.git
e3cb324ed9
1. Escape asterisks and underscores, that have special meaning in Markdown. While most markdown processors are smart enough to distinguish whether it's a literal * or _ or a formatting directive, escaping makes things more explicit. 2. Fix using wrong level of headings in some dm options (most are ####, but some were #####). 3. Do not use sub-heading for examples in some dm options (this is how it's done in the rest of the man page). Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| Dockerfile.5.md | ||
| README.md | ||
| docker-build.1.md | ||
| docker-config-json.5.md | ||
| docker-run.1.md | ||
| docker.1.md | ||
| dockerd.8.md | ||
| generate.go | ||
| go.mod | ||
| tools.go | ||
README.md
Docker Documentation
This directory contains scripts for generating the man pages. Many of the man
pages are generated directly from the spf13/cobra Command definition. Some
legacy pages are still generated from the markdown files in this directory.
Do not edit the man pages in the man1 directory. Instead, update the
Cobra command or amend the Markdown files for legacy pages.
Generate the man pages
From within the project root directory run:
$ make -f docker.Makefile manpages