https://github.com/codeboxrcodehub/comforthrmdocs
Documentation for comfort hrm plugins/modules
https://github.com/codeboxrcodehub/comforthrmdocs
Last synced: 11 months ago
JSON representation
Documentation for comfort hrm plugins/modules
- Host: GitHub
- URL: https://github.com/codeboxrcodehub/comforthrmdocs
- Owner: codeboxrcodehub
- Created: 2024-12-05T11:00:08.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-25T10:11:04.000Z (11 months ago)
- Last Synced: 2025-02-25T11:24:08.326Z (11 months ago)
- Language: JavaScript
- Size: 1.24 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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.
```bash
git clone https://github.com/codeboxrcodehub/comforthrmdocs.git
cd Comfort HRM
npm install
npm run docs:dev
```
Visit [https://localhost:5173](https://localhost:5173) to see your site
## Build
You may run this command to build the docs
```bash
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
```