diff --git a/docs/README.md b/docs/README.md index a307f0a0cc2c2ba585b6e19519ec55ea1474e2ee..3ba19e7224618f55717d60568713b64d7938252e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,7 @@ # Build documentation with MkDocs OceanBase documentation is built with [MkDocs](https://www.mkdocs.org/). You can check [`mkdocs.yml`](mkdocs.yml) for more information. +Please install MkDocs according to [the installation documents of MkDocs](https://www.mkdocs.org/user-guide/installation/) ## Requirements @@ -8,13 +9,16 @@ Before installing dependencies, please make sure you have installed a recent ver Then you can run the following command in your terminal at current directory: - $ pip install -r requirements.txt - +``` +$ pip install -r requirements.txt +``` ## Build the documentation You can build the documentation by running the following command: - $ mkdocs build +``` +$ mkdocs build +``` This will create a new directory to store the output files, which is `site/` by default. @@ -22,8 +26,9 @@ This will create a new directory to store the output files, which is `site/` by You can start a server locally by running the following command: - $ mkdocs serve - +``` +$ mkdocs serve +``` Open up http://127.0.0.1:8000/ in your browser, and you'll see the default home page. ## Modify pages diff --git a/docs/requirements.txt b/docs/requirements.txt index 382aa9a1836134e96a301e535b358b396d73e157..b4ee4e868acc96f0c62574767a89c0c09d03dbee 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -8,3 +8,4 @@ mkdocs-git-revision-date-localized-plugin weasyprint mkdocs-with-pdf qrcode +mkdocs-material