Welcome, this site contains the latest UVdesk documentation for users and developers. You can find the online version of the documentation at https://uvdesk.github.io/
Our goal is to provide the UVdesk community with comprehensive and quality technical documentation.
We believe that to accomplish our goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving UVdesk documentation.
Like our work, contribute here
For local builds, you need to install Ruby 2.4 or later.
To check the Ruby version on your environment, run in your terminal:
$ ruby -v
$ brew install ruby
See the Ruby site for instructions.
Install the Bundler gem, which helps with Ruby dependencies:
$ gem install bundler
Open your system's terminal emulator, browse to the cloned respository and follow the following steps:
To install Jekyll dependencies, run:
$ bundle install
To generate the local preview, run:
bundle exec jekyll serve
Configuration file: /Users/username/Github/uvdocs/_config.yml
Source: /Users/username/Github/devdocs
Destination: /Users/username/Github/devdocs/_site
Incremental build: disabled
Generating...
done in x.x seconds.
Auto-regeneration: enabled for '/Users/username/Github/uvdocs'
Server address: http://127.0.0.1:4000//
Server running... press ctrl-c to stop.
OR
If port 4000 is engaged then put another port and run project using below command.
For Example:
bundle exec jekyll serve --livereload --port 4001
Use the Server address URL http://127.0.0.1:4000/ in a browser to preview the content.
Press Ctrl+C
in the serve terminal to stop the server.
TIP You can learn about Jekyll from here
All the libraries and content included in this documentation are released under the MIT or BSD license.