Install MkDocs - Read the Docs Alternative - on Windows
#MkDocs #Python #Windows Full steps can be found at https://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. - https://github.com/mkdocs/mkdocs -------------------------------------------------------------------- Installation -------------------------------------------------------------------- 01. Log into the Windows device 02. Download Python https://www.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: https://www.mkdocs.org/getting-started/ ### Connect with me and others ### ★ Discord: https://discord.com/invite/EzenvmSHW8 ★ Reddit: https://reddit.com/r/i12bretro ★ Twitter: https://twitter.com/i12bretro
Download
1 formatsVideo Formats
Right-click 'Download' and select 'Save Link As' if the file opens in a new tab.