README.md

Docker Handbook

A simple and short Docker guideline.

Website

To visit the website click here.

How to run on local machine

Step 1: Clone repository

    git clone git@github.com:tabpole/docker-handbook.git

Step 2: npm dependencies

    npm install

Step 3: run documentation site on browser

    npm run docs:dev

Other Commands :

    npm run docs:build
    npm run docs:preview

Contribution commands

To make a contribution fork this repository then apply following commands and make a pull request to main branch.

Sequential commands:

    git add .
    git commit -m 'appropriate message'
    git pull origin main
    git push origin main

Move dist files into 'site' branch

Sequential commands

    git checkout site
    rm -rf  !("node_modules"|"docs"|".gitignore")
    cp -rf docs/.vitepress/dist/* .
    git add .
    git commit -m 'deployment'
    git pull origin site
    git push origin site
    git checkout main

Others commands :

    git checkout main docs/.vitepress/dist

Build tool

This documentation site is built using vitepress.