Skip to content

ravisivan/InstallerX-Revived-Website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InstallerX Revived Website

This repository contains the official documentation website for InstallerX Revived, built with VitePress.

About

This repository is dedicated to the documentation website only.
The main application source code is maintained in the primary InstallerX Revived repository.

The site includes:

  • English documentation
  • Simplified Chinese documentation
  • User guides and installation instructions
  • Feature explanations and FAQ pages

Development

Install dependencies:

npm install

Start the local development server:

npm run docs:dev

Build the site:

npm run docs:build

Preview the production build locally:

npm run docs:preview

Project Structure

.
├── docs/                         # VitePress documentation source
│   ├── .vitepress/               # Site configuration and theme settings
│   ├── guide/                    # English documentation
│   └── zh/                       # Simplified Chinese documentation
├── .github/workflows/            # GitHub Pages deployment workflow
├── package.json
├── package-lock.json
└── LICENSE

Deployment

The website is automatically built and deployed to GitHub Pages through GitHub Actions.

Deployments are triggered when changes are pushed to the main branch and affect:

  • docs/**
  • package.json
  • package-lock.json
  • .github/workflows/deploy-docs.yml

Contributing

Documentation improvements are welcome.

To contribute:

  1. Fork this repository.
  2. Create a new branch.
  3. Edit or add documentation under docs/.
  4. Submit a pull request.

You can also use the “Edit this page on GitHub” link available on each documentation page.

License

This project is released under the GPL-3.0 License.

About

The doc of InstallerX Revived

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors