Install MkDocs - Read the Docs Alternative - on Windows @i12bretro
Install MkDocs - Read the Docs Alternative - on Windows  @i12bretro
Uploaded January 2025 | Updated November 2026, 2 hours ago
#MkDocs #Python #Windows

Full steps can be found at i12bretro.github.io/tutorials/0984.html

--------------------------------------------------------------------
What is MkDocs?
--------------------------------------------------------------------
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions. -  github.com/mkdocs/mkdocs
 
--------------------------------------------------------------------
Installation
--------------------------------------------------------------------
   01. Log into the Windows device
   02. Download Python  python.org/downloads
   03. Run the downloaded Python installer, making sure to check the option to add Python to the path
   04. Launch PowerShell as Administrator
   05. Run the following commands in PowerShell
         # upgrade pip
         pip install --upgrade pip
         # create a mkdocs directory in user directory
         mkdir $ENV:UserProfile\mkdocs
         # change directory to mkdocs
         cd $ENV:UserProfile\mkdocs
         # install mkdocs
         pip install mkdocs
         # create a mkdocs site
         mkdocs new mkdocs-demo
         # change directory to mkdocs-demo
         cd mkdocs-demo
         # start the demo site
         mkdocs serve
   06. Open a web browser and navigate to http://DNSorIP:8000
 
--------------------------------------------------------------------
Read the Docs Theme
--------------------------------------------------------------------
   01. Back in PowerShell, press CTRL+C to kill the running process
   02. Run the following command
         # open the mkdocs config file in notepad
         notepad "$ENV:UserProfile\mkdocs\mkdocs-demo\mkdocs.yml"
   03. Add the following line to mkdocs.yml
         theme: readthedocs
   04. Save the change and close Notepad
   05. Run the following command to see the change
         # restart the demo site
         mkdocs serve
 
Source:  mkdocs.org/getting-started
 


### Connect with me and others ###
★ Discord: discord.com/invite/EzenvmSHW8
★ Reddit: reddit.com/r/i12bretro
★ Twitter: twitter.com/i12bretro
Install MkDocs - Read the Docs Alternative - on WindowsRoll Your Own Self-Hosted PHP Sandbox PageRunning a MX Linux VM in Proxmox VECreate and Apply SSL Certificate to TrueNAS Web UIInstall AdGuard Home - Cross Platform Pi Hole Alternative - on ArmbianInstall Homer Application Dashboard on LinuxRun MyBB - Open Source Forum Software - in DockerInstalling and Setting Up Squid Proxy Server on DebianRunning a Vanilla ChromiumOS VM in VirtualboxRun VSCodium Containerized in DockerSelf-hosted Wikipedia Style Wiki with MediaWiki on DebianInstalling Windows Subsystem for Linux (WSL) Inside VirtualBox VM
i12bretro |

Install MkDocs - Read the Docs Alternative - on Windows

SHARE TO X SHARE TO REDDIT SHARE TO FACEBOOK WALLPAPER