Comfort HRM

A docs template built using VitePress

This repository serves as a resource for the tutorial, How to Build a Modern Documentation Site with VitePress posted on freeCodeCamp

Run project locally

Use this command below to boot this project locally.

git clone https://github.com/codeboxrcodehub/comforthrmdocs.git

cd Comfort HRM

npm install

npm run docs:dev

Visit https://localhost:5173 to see your site

Build

You may run this command to build the docs

npm run docs:build

Folder Structure

docs/
├── .vitepress/
│   ├── config.js
│   └── theme/
│       ├── index.js
│       └── custom.css
├── public/
│   ├── logo.png
│   └── logo-big.svg
├── about.md
├── configs.md
├── contact.md
├── get-started.md
├── guide.md
├── index.md
├── package.json
└── README.md