Add Chinese Modes and Tasks Docs (#6274)
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
parent
795b95bdcb
commit
e3a538bbde
293 changed files with 3681 additions and 736 deletions
|
|
@ -52,6 +52,32 @@ While the site is being served, you can make changes to the documentation files
|
|||
|
||||
To stop the serve command and terminate the local server, you can use the `CTRL+C` keyboard shortcut.
|
||||
|
||||
### Building and Serving Multi-Language
|
||||
|
||||
For multi-language MkDocs sites use the following additional steps:
|
||||
|
||||
1. Add all new language *.md files to git commit: `git add docs/**/*.md -f`
|
||||
2. Build all languages to the `/site` directory. Verify that the top-level `/site` directory contains `CNAME`, `robots.txt` and `sitemap.xml` files, if applicable.
|
||||
|
||||
```bash
|
||||
# Remove existing /site directory
|
||||
rm -rf site
|
||||
|
||||
# Loop through all *.yml files in the docs directory
|
||||
for file in docs/*.yml; do
|
||||
echo "Building MkDocs site with configuration file: $file"
|
||||
mkdocs build -f "$file"
|
||||
done
|
||||
```
|
||||
|
||||
3. Preview in web browser with:
|
||||
|
||||
```bash
|
||||
cd site
|
||||
python -m http.server
|
||||
open http://localhost:8000 # on macOS
|
||||
```
|
||||
|
||||
### Deploying Your Documentation Site
|
||||
|
||||
To deploy your MkDocs documentation site, you will need to choose a hosting provider and a deployment method. Some popular options include GitHub Pages, GitLab Pages, and Amazon S3.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue