To get started with this user-docs, follow these steps:
Make sure you have Node.js and npm installed on your machine.
-
Clone this repository:
git clone https://github.com/scantist/user-docs.git cd user-docs
-
Install the dependencies:
npm install .
To run the application locally and start the development server, use the following command:
npm run docs:dev
This command will start a local server and open the documentation site in your default web browser.
To build the documentation for production, use:
npm run docs:build
This will generate the static files for your documentation in the .vitepress/dist
directory.
The important folders/files in this project are:
docs
: Contains the Markdown files for your documentation.package.json
: Contains the project's dependencies and scripts.vite.config.js
: Configuration file for VitePress.
You may need to read up on the Jenkinsfile
and understand how to use the companyConfig.js