Guide for publishing docs

Welcome

Welcome to my Documentation site!.

This site is a one shop stop for all the projects i have done, their descriptions and procedures on how the task was achieved. This site will not have the entirety of the code rather this is a place you can find th eworkflows for all the different projects I have done successfully.

This site relies entirely on markdown file from my gitlab repository. This first post outline on how to create a good markdown file for the site to host.

Creating a Post using markdown

For a markdown file, there are many different syntax we can use to make the file readable. Following are few thing I often use in my .md files

1. An unordered list

   • point one
   • point two
   • point three
   • point four
   • point five

2. Code blocks:

I especially love code block as they can automatically identify the language(using three backticks following the language name) and format them based on the language mentioned. Below are the few common examples

echo "Hello World"

stage:
 - stage1
 - stage2
 - stage3

stage1:
  - echo "Stage1"

stage2:
  - echo "Stage2"

fmt.println("helloworld)

1. Photos

For photos, WE can include the local photo or we can copy the address of the image from the web and use that to include any photos

Publishing

This current site is hosted on Gitlab(whose runners are running on self hosted servers in my home). Since this is a Gitlab Repository, I just have to push the code to the main repository after testing out. Once the code is pushed to the main branch, the gitlab pages will do its thing and will host the site on my domain.