|
1 | 1 | # Show help and exit |
2 | 2 | extern "mkdocs" [ |
3 | | - |
| 3 | + --help(-h) # Show help and exit |
| 4 | + --verbose(-v) # Enable verbose output |
| 5 | + --quiet(-q) # Silence warnings |
| 6 | + --version(-V) # Show the version and exit |
| 7 | + --clean(-c) # Remove old site_dir before building (the default) |
| 8 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 9 | + --theme(-t) # The theme to use when building your documentation |
| 10 | + --clean(-c) # Remove old site_dir before building (the default) |
| 11 | + --force # Force the push to the repository |
| 12 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 13 | + --theme(-t) # The theme to use when building your documentation |
| 14 | + --livereload # Enable the live reloading in the development server (this is the default) |
| 15 | + --no-livereload # Disable the live reloading in the development server |
| 16 | + --dirtyreload # Enable the live reloading in the development server, but only re-build files that have changed |
4 | 17 | ...args |
5 | 18 | ] |
6 | 19 |
|
7 | 20 | # Build the MkDocs documentation |
8 | 21 | extern "mkdocs build" [ |
| 22 | + --help(-h) # Show help and exit |
| 23 | + --verbose(-v) # Enable verbose output |
| 24 | + --quiet(-q) # Silence warnings |
9 | 25 | --version(-V) # Show the version and exit |
10 | 26 | --clean(-c) # Remove old site_dir before building (the default) |
11 | 27 | --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
12 | 28 | --theme(-t) # The theme to use when building your documentation |
| 29 | + --clean(-c) # Remove old site_dir before building (the default) |
| 30 | + --force # Force the push to the repository |
| 31 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 32 | + --theme(-t) # The theme to use when building your documentation |
| 33 | + --livereload # Enable the live reloading in the development server (this is the default) |
| 34 | + --no-livereload # Disable the live reloading in the development server |
| 35 | + --dirtyreload # Enable the live reloading in the development server, but only re-build files that have changed |
13 | 36 | ...args |
14 | 37 | ] |
15 | 38 |
|
16 | 39 | # Deploy your documentation to GitHub Pages |
17 | 40 | extern "mkdocs gh-deploy" [ |
| 41 | + --help(-h) # Show help and exit |
| 42 | + --verbose(-v) # Enable verbose output |
| 43 | + --quiet(-q) # Silence warnings |
18 | 44 | --version(-V) # Show the version and exit |
19 | 45 | --clean(-c) # Remove old site_dir before building (the default) |
| 46 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 47 | + --theme(-t) # The theme to use when building your documentation |
| 48 | + --clean(-c) # Remove old site_dir before building (the default) |
20 | 49 | --force # Force the push to the repository |
| 50 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 51 | + --theme(-t) # The theme to use when building your documentation |
| 52 | + --livereload # Enable the live reloading in the development server (this is the default) |
| 53 | + --no-livereload # Disable the live reloading in the development server |
| 54 | + --dirtyreload # Enable the live reloading in the development server, but only re-build files that have changed |
21 | 55 | ...args |
22 | 56 | ] |
23 | 57 |
|
24 | 58 | # Run the builtin development server |
25 | 59 | extern "mkdocs serve" [ |
| 60 | + --help(-h) # Show help and exit |
| 61 | + --verbose(-v) # Enable verbose output |
| 62 | + --quiet(-q) # Silence warnings |
26 | 63 | --version(-V) # Show the version and exit |
| 64 | + --clean(-c) # Remove old site_dir before building (the default) |
| 65 | + --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
| 66 | + --theme(-t) # The theme to use when building your documentation |
| 67 | + --clean(-c) # Remove old site_dir before building (the default) |
| 68 | + --force # Force the push to the repository |
27 | 69 | --strict(-s) # Enable strict mode. This will cause MkDocs to abort the build on any warnings |
28 | 70 | --theme(-t) # The theme to use when building your documentation |
29 | 71 | --livereload # Enable the live reloading in the development server (this is the default) |
|
0 commit comments