Basic setup and introduction of mkdocs and gitlab in VScode for Github or Gitlab using SSH or HTTPS

Published: 25 January 2022
on channel: Adam Harris

4,149

Below I have pasted the commands you will need so you can copy/paste them.

Open terminal in VScode from your project folder.

cd into the directory of your repo if you aren't already there.

pip install mkdocs-material

pip3 install mkdocs-git-revision-date-localized-plugin

cd .. #goes to one directory above the current one

mkdocs new site #creates a new mkdocs website

cd site # move back into the current repository

mkdocs serve #See the local copy of the webpage

Edit your mkdocs.yaml file to list your name, and URL, etc. You can also change the theme colors if you'd like. Check out how to customize your theme: https://squidfunk.github.io/mkdocs-ma...

See here for how to add pages to your site: https://www.mkdocs.org/user-guide/wri...

Save your files.

Push these to the remote repo (gitlab site)
git add # stage changed files
git commit -m "Describe changes in this commit"
git push

On this page of the site you can watch the video online Basic setup and introduction of mkdocs and gitlab in VScode for Github or Gitlab using SSH or HTTPS with a duration of hours minute second in good quality, which was uploaded by the user Adam Harris 25 January 2022, share the link with friends and acquaintances, this video has already been watched 4,149 times on youtube and it was liked by 28 viewers. Enjoy your viewing!

13,912

323