Skip to content

Commit 590ad02

Browse files
deepakdebdeepakdeb
committed
docs updated
1 parent 5b5d66c commit 590ad02

36 files changed

+608
-95
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Use this command below to boot this project locally.
1111

1212
```bash
13-
git clone https://github.com/Evavic44/Comfort HRM.git
13+
git clone https://github.com/codeboxrcodehub/comforthrmdocs.git
1414

1515
cd Comfort HRM
1616

‎docs/.vitepress/config.ts‎

Lines changed: 107 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ export default {
22
title: "Comfort HRM",
33
description: "An awesome docs template built by me",
44
lang: 'en-US',
5-
cleanUrls: true,
5+
// cleanUrls: true,
66
base: '/comforthrmdocs/',
77
// If this is disabled, when building it it will give deadlink errors if your markdown has the wrong links
88
ignoreDeadLinks: true,
@@ -15,64 +15,122 @@ export default {
1515
},
1616
// Navbar Link
1717
nav: [
18-
{ text: "CBX Bookmark", link: "/bookmark" },
19-
{ text: "Configs", link: "/configs" },
18+
{ text: "Comform Job", link: "/comfortjob/" },
19+
{ text: "Comfort Resume", link: "/comfortresume/" },
20+
{ text: "Comfort Job Application", link: "/comfortjobapp/" },
21+
// {
22+
// // Dropdown Menu
23+
// text: "Changelog",
24+
// items: [
25+
// { text: "v0.0.1", link: "/item-1" },
26+
// { text: "v0.0.2", link: "/item-2" },
27+
// { text: "v0.0.3", link: "/item-3" },
28+
// ],
29+
// },
30+
],
31+
//Social Icons
32+
socialLinks: [
33+
{ icon: "github", link: "https://github.com/codeboxrcodehub/comforthrmdocs" },
34+
{ icon: "twitter", link: "https://twitter.com/victorekea" },
35+
{ icon: "discord", link: "..." },
2036
{
21-
// Dropdown Menu
22-
text: "Changelog",
23-
items: [
24-
{ text: "v0.0.1", link: "/item-1" },
25-
{ text: "v0.0.2", link: "/item-2" },
26-
{ text: "v0.0.3", link: "/item-3" },
27-
],
37+
icon: {
38+
svg: '<svg role="img" width="26.01" height="32" viewBox="0 0 256 315"><path d="M213.803 167.03c.442 47.58 41.74 63.413 42.197 63.615c-.35 1.116-6.599 22.563-21.757 44.716c-13.104 19.153-26.705 38.235-48.13 38.63c-21.05.388-27.82-12.483-51.888-12.483c-24.061 0-31.582 12.088-51.51 12.871c-20.68.783-36.428-20.71-49.64-39.793c-27-39.033-47.633-110.3-19.928-158.406c13.763-23.89 38.36-39.017 65.056-39.405c20.307-.387 39.475 13.662 51.889 13.662c12.406 0 35.699-16.895 60.186-14.414c10.25.427 39.026 4.14 57.503 31.186c-1.49.923-34.335 20.044-33.978 59.822M174.24 50.199c10.98-13.29 18.369-31.79 16.353-50.199c-15.826.636-34.962 10.546-46.314 23.828c-10.173 11.763-19.082 30.589-16.678 48.633c17.64 1.365 35.66-8.964 46.64-22.262"/></svg>',
39+
},
40+
link: "https://google.com",
2841
},
2942
],
30-
// Social Icons
31-
// socialLinks: [
32-
// { icon: "github", link: "https://github.com/Evavic44/Comfort HRM" },
33-
// { icon: "twitter", link: "https://twitter.com/victorekea" },
34-
// { icon: "discord", link: "..." },
43+
44+
sidebar: {
45+
// Sidebar for `/docs/` section
46+
'/comfortjob/': [
47+
{
48+
text: 'Comfort Job',
49+
collapsible: true,
50+
items: [
51+
{ text: 'How to install', link: '/comfortjob/how-to-install' },
52+
{ text: 'How to Translate', link: '/comfortjob/how-to-translate' },
53+
{ text: 'Template Override', link: '/comfortjob/template-override' },
54+
{ text: 'Shortcodes', link: '/comfortjob/shortcodes' },
55+
{ text: 'Classic Widgets', link: '/comfortjob/classic-widgets' },
56+
{ text: 'Elementor Widget', link: '/comfortjob/elementor-widgets' },
57+
{ text: 'Gutenberg Blocks', link: '/comfortjob/gutenberg-blocks' },
58+
{ text: 'Hooks and Filters', link: '/comfortjob/hooks-and-filters' },
59+
{ text: 'Code Samples', link: '/comfortjob/code-samples' },
60+
],
61+
}
62+
],
63+
64+
// Sidebar for `/guide/` section
65+
'/comfortresume/': [
66+
{
67+
text: 'Comfort Resume',
68+
collapsible: true,
69+
items: [
70+
{ text: 'How to install', link: '/comfortresume/how-to-install' },
71+
{ text: 'How to Translate', link: '/comfortresume/how-to-translate' },
72+
{ text: 'Template Override', link: '/comfortresume/template-override' },
73+
{ text: 'Shortcodes', link: '/comfortresume/shortcodes' },
74+
{ text: 'Classic Widgets', link: '/comfortresume/classic-widgets' },
75+
{ text: 'Elementor Widget', link: '/comfortresume/elementor-widgets' },
76+
{ text: 'Gutenberg Blocks', link: '/comfortresume/gutenberg-blocks' },
77+
{ text: 'Hooks and Filters', link: '/comfortresume/hooks-and-filters' },
78+
{ text: 'Code Samples', link: '/comfortresume/code-samples' },
79+
],
80+
},
81+
],
82+
'/comfortjobapp/': [
83+
{
84+
text: 'Comfort Job Application',
85+
collapsible: true,
86+
items: [
87+
{ text: 'How to install', link: '/comfortjobapp/how-to-install' },
88+
{ text: 'How to Translate', link: '/comfortjobapp/how-to-translate' },
89+
{ text: 'Template Override', link: '/comfortjobapp/template-override' },
90+
{ text: 'Shortcodes', link: '/comfortjobapp/shortcodes' },
91+
{ text: 'Hooks and Filters', link: '/comfortjobapp/hooks-and-filters' },
92+
{ text: 'Code Samples', link: '/comfortjobapp/code-samples' },
93+
],
94+
},
95+
],
96+
97+
},
98+
99+
100+
//Sidebar
101+
// sidebar: [
102+
// {
103+
// text: "Section A",
104+
// collapsible: true,
105+
// items: [
106+
// { text: "Introduction", link: "/introduction" },
107+
// { text: "Getting Started", link: "/getting-started" },
108+
// ],
109+
// },
35110
// {
36-
// icon: {
37-
// svg: '<svg role="img" width="26.01" height="32" viewBox="0 0 256 315"><path d="M213.803 167.03c.442 47.58 41.74 63.413 42.197 63.615c-.35 1.116-6.599 22.563-21.757 44.716c-13.104 19.153-26.705 38.235-48.13 38.63c-21.05.388-27.82-12.483-51.888-12.483c-24.061 0-31.582 12.088-51.51 12.871c-20.68.783-36.428-20.71-49.64-39.793c-27-39.033-47.633-110.3-19.928-158.406c13.763-23.89 38.36-39.017 65.056-39.405c20.307-.387 39.475 13.662 51.889 13.662c12.406 0 35.699-16.895 60.186-14.414c10.25.427 39.026 4.14 57.503 31.186c-1.49.923-34.335 20.044-33.978 59.822M174.24 50.199c10.98-13.29 18.369-31.79 16.353-50.199c-15.826.636-34.962 10.546-46.314 23.828c-10.173 11.763-19.082 30.589-16.678 48.633c17.64 1.365 35.66-8.964 46.64-22.262"/></svg>',
38-
// },
39-
// link: "https://google.com",
111+
// text: "Section B",
112+
// collapsible: false,
113+
// items: [
114+
// { text: "Introduction", link: "/introduction" },
115+
// { text: "Getting Started", link: "/getting-started" },
116+
// ],
117+
// },
118+
// {
119+
// text: "Section C",
120+
// collapsible: true,
121+
// items: [
122+
// { text: "Introduction", link: "/introduction" },
123+
// { text: "Getting Started", link: "/getting-started" },
124+
// ],
40125
// },
41126
// ],
42-
// Sidebar
43-
sidebar: [
44-
{
45-
text: "Section A",
46-
collapsible: true,
47-
items: [
48-
{ text: "Introduction", link: "/introduction" },
49-
{ text: "Getting Started", link: "/getting-started" },
50-
],
51-
},
52-
{
53-
text: "Section B",
54-
collapsible: false,
55-
items: [
56-
{ text: "Introduction", link: "/introduction" },
57-
{ text: "Getting Started", link: "/getting-started" },
58-
],
59-
},
60-
{
61-
text: "Section C",
62-
collapsible: true,
63-
items: [
64-
{ text: "Introduction", link: "/introduction" },
65-
{ text: "Getting Started", link: "/getting-started" },
66-
],
67-
},
68-
],
69127
// you can disable the previous and next page here
70128
docFooter: {
71-
prev: false,
72-
next: true,
129+
prev: 'Previous',
130+
next: 'Next',
73131
},
74132
editLink: {
75-
pattern: 'https://github.com/Evavic44/Comfort HRM/edit/main/docs/:path',
133+
pattern: 'https://github.com/codeboxrcodehub/comforthrmdocs/edit/main/docs/:path',
76134
text: 'Edit this page on GitHub'
77135
},
78136
footer: {

‎docs/about.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎docs/bookmark.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/comfortjob/classic-widgets.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Classic Widgets
2+
3+
WordPress currently doesn’t support classic widgets but still you can enable it by using this plugin [“Classic Widgets”](https://wordpress.org/plugins/classic-widgets/)
4+
5+
Comfort Job for WordPress plugin supports classic widgets. To add Comfort Job classic widget from dashboard.
6+
7+
**Appearance -> Widgets -> Comfort Job**
8+
9+
Drag the “CBX Changelog” widget from left to any right-side sidebar(s).
10+
11+
After adding the widget to the sidebar, you can adjust the input fields and check your frontend.
12+
\[Video coming soon\]
13+
14+
The following classic widgets(currently 0 widgets (core and pro)) can be accessed from wordpress dashboard widget manager. We will keep adding more classic widgets for this plugin in future as needed. All widgets has shortcode and same params.
15+
16+
17+
18+
**Last modified:** December 9, 2024

‎docs/comfortjob/code-samples.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code Samples
2+
3+
4+
5+
**Last modified:** December 9, 2024

‎docs/comfortjob/elementor-widgets.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Elementor Widgets
2+
3+
4+
5+
**Last modified:** December 9, 2024

‎docs/comfortjob/gutenberg-blocks.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Gutenberg Blocks
2+
3+
4+
5+
**Last modified:** December 9, 2024

‎docs/comfortjob/hooks-and-filters.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Hooks and Filters
2+
3+
4+
5+
**Last modified:** December 9, 2024

‎docs/comfortjob/how-to-install.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# How to Install
2+
3+
The core plugin name is **“Comfort Job”** and our pro addon name is **“Comfort Job Pro Addon”**.
4+
5+
## How to install any plugin
6+
7+
Before we know how to install “Comfort Job” plugin if we know how to install any WordPress plugin it will be smarter. WordPress.org has very clear and step by instruction for [how to install a plugin](https://wordpress.org/documentation/article/manage-plugins/#installing-plugins-1) from wordpress plugin directory or zip version of a plugin. If you read the article from wordpress.org then now you have basic idea how to install a plugin.
8+
9+
## How to install “Comfort Job” Core Plugin
10+
11+
You can install Comfort Job plugin from your wordpress dashboard -> Plugins -> Add New and then search by the name. Then download the zip file from wordpress.org [plugin dir](https://wordpress.org/plugins/comfortjob/) and install manually.
12+
13+
## How to install “Comfort Job Pro Addon”
14+
15+
**Comfort Job Addon** doesn’t work without the core plugin **Comfort Job**. So, before you install the pro addon you need to have the core Comfort Job plugin installed and activated (if you want to activate this pro addon). So, Comfort Job Pro Addon is an addon plugin for core plugin Comfort Job.
16+
To install CBX Changelog Pro Addon you have to purchase [license and download](https://codeboxr.com/product/cbx-changelog-for-wordpress/#downloadarea) from our website and then install manually.
17+
18+
**Last modified:** December 9, 2024

0 commit comments

Comments
 (0)