Skip to content

Commit

Permalink
[update][doc] Add documentation build/publish guide
Browse files Browse the repository at this point in the history
  • Loading branch information
wgzhao committed May 31, 2024
1 parent 9cb12ca commit 145d131
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,31 @@ Failed record : 0
- [online](https://wgzhao.github.io/Addax/)
- [project](docs/index.md)
### compile
First, you need install the following python3 modules
```python
python3 -m pip install mkdocs-material
```
you can using `mkdocs` command to build or preview on local
```shell
mkdocs build
mkdocs serve -a 0.0.0.0:8888
```
using the following command to publish release doc
```shell
export version=4.1.5
git checkout $version
mike deploy $version
git checkout gh-pages
git push -u origin gh-pages
```
## Code Style
We recommend you use IntelliJ as your IDE. The code style template for the project can be found in the [codestyle](https://github.com/airlift/codestyle) repository along with our general programming and Java guidelines. In addition to those you should also adhere to the following:
Expand Down

0 comments on commit 145d131

Please sign in to comment.