How To Improve Your Software Documentation by Connecting Gitlab with Mkdocsby@hatembentayeb

How To Improve Your Software Documentation by Connecting Gitlab with Mkdocs

tldt arrow
Read on Terminal Reader
Read this story w/o Javascript

Too Long; Didn't Read

Devops engineer and technical writer shares his way of generating docs using the devops approach. He uses a set of tools that must be available on your machine: python3, python 3.8 (latest), virtualenv, mkdocs and mkdocs material. GitLab offers a feature called gitlab pages that can serve for free a static resource (HTML, js, CSS) The repo path is converted to an URL to your docs. The site will be accessible on http://locahost:8000 and you should see the initial look.

Company Mentioned

Mention Thumbnail
featured image - How To Improve Your Software Documentation by Connecting Gitlab with Mkdocs
hatem ben tayeb HackerNoon profile picture

@hatembentayeb

hatem ben tayeb

Archlinux User | Devops engineer | Technical writer | Automation enthusiast | IaaC | CaaC | GitOps


Receive Stories from @hatembentayeb

react to story with heart
hatem ben tayeb HackerNoon profile picture
by hatem ben tayeb @hatembentayeb.Archlinux User | Devops engineer | Technical writer | Automation enthusiast | IaaC | CaaC | GitOps
Read My Stories

RELATED STORIES

L O A D I N G
. . . comments & more!