Home¶
Overview¶
Vittetsens Docs provides a collection of documentations for Vittetsens developers. If some descriptions are incorrect, you can edit it from 'vittetsens/vittetsens-docs' repository.
Guide¶
Editing¶
Push the edited document to the main branch of the repository and wait for a while to upload it to the Cloudflare Pages server. Both upload and build operations are processed automatically, so you don't have to do anything else.
Note, however, that if you add a new document, you must modify the nav property in mkdocs.yml to display it.
Building¶
# 1. Go to the project directory
cd {prj_dir}
# 2. Activate a venv
python -m venv venv
./venv/Scripts/Activate.ps1
# 3. Install all requirements
pip install -r requirements.txt
# 4. Run test server or build
mkdocs serve
mkdocs build
MkDocs / Material for MkDocs¶
Vittetsens Docs uses MkDocs and Material for MkDocs. Additional informations can be found in the links below.
Contacts¶
If you have any questions about Vittetsens Docs system, please contact us using the following methods.