mkDocs

Official Website: https://www.mkdocs.org/
User Guide: https://www.mkdocs.org/user-guide

System Requirements

MkDocs can be installed on various operating systems, but your system needs to support Python and pip (Python’s package manager):

Python: MkDocs requires Python (>=3.7)
pip: MkDocs is installed using pip, which is bundled with most Python installations

You can verify your the requierements by running:

python --version

pip --version

If Python or pip are not installed, follow the steps below to install them.

Installing Python and pip

Download Python

Go to the official Python download page: https://www.python.org/downloads/
Download the latest version of Python (ensure it’s version 3.7 or higher).

Run the Installer

Double-click the downloaded installer.
On the installation screen, make sure to check the box “Add Python to PATH”.
Click “Install Now” and follow the prompts.

Once the installation is complete, go back to the previos step to verify the installation.

SVN Repository

Once the system requirements are met, check out the following SVN repository:
https://svn.woojin.info/svn/Manual/60_MkDocs

Install & Run Project

Install Requirements

Double-click the setup_requirements.bat file to install all necessary dependencies.
After successful execution, a folder named myprojectenv should be created inside the project directory.

Run the Project

Double-click the serve.bat file to start the MkDocs server.
A terminal window will open and should look similar to this:

The documentation should now be running locally on port 8000: http://127.0.0.1:8000/.
Keep this terminal window open as long as you are working on the project!!

Modifying Documentation

Inside the docs folder you can find a folder for every available language:

Within the docs folder, you will find subfolders for each available language.

Each folder contains markdown (.md) files that represent the content of individual pages.
Modifying these files will update the corresponding content in the documentation.

For basic syntax and best practices when editing markdown files, refer to this guide: https://www.markdownguide.org/basic-syntax