OYMotion Community Web Site

The web site https://oymotion.github.io is built upon mkDocs

How to contribute

• Install mkDocs

pip install mkdocs

Please refer to How to Install mkdocs

• Install required theme

pip install mkdocs-material
pip install mkdocs-static-i18n
pip install mkdocs-document-dates

• Make some changes

git clone https://github.com/oymotion/oymotionDeveloperCommunity.git
cd oymotionDeveloperCommunity
...(make some changes)
mkdocs serve

note mkdocs.exe can be found in "%LOCALAPPDATA%\Packages\PythonSoftwareFoundation.Python.3.10_*\LocalCache\local-packages\Python310\Scripts" on Windows.

Then you would be able to preview the web page at http://localhost:8000

How to Update web site as oymotion owner

• Install mkDocs

pip install mkdocs

Please refer to How to Install mkdocs

• Deploying Docs

git clone https://github.com/oymotion/oymotionDeveloperCommunity.git
git remote add oymotionIO https://github.com/oymotion/oymotion.github.io.git
cd oymotionDeveloperCommunity
...(merge pull request or make some changes by yourself)
mkdocs gh-deploy
git checkout gh-pages
git push oymotionIO gh-pages:master

Note: You should never edit any files in oymotion.github.io repository and gh-pages branch by hand otherwise you will lose your work.

For more details about mkdocs gh-deploy,please refer to How to Deploying Docs