Welcome to the Volaris Documentation site! This repository contains the code for the official documentation of the Volaris encryption tool, built with SvelteKit and styled using Tailwind CSS.
The Volaris Documentation site provides users with detailed information about the Volaris encryption tool, including guides, FAQs, and getting started instructions. The site is designed to be minimalist and responsive, featuring smooth animations and a clean layout.
src/routes/: Main homepage of the documentation.src/lib/global.css: Global CSS styles.src/lib/style404.css: 404 Page's CSS styles.src/routes/docs/introduction: Introduction to Volaris.src/routes/docs/installing-building: Guide to installing/building Volaris.src/routes/faq/: Frequently asked questions.
To set up and run the project locally, follow these steps:
-
Clone the Repository
git clone https://github.com/volar-is/volaris-docs.git cd volaris-docs -
Install Dependencies
pnpm install
-
Start the Development Server
pnpm run dev
The local development server will be available at
http://localhost:5173.
We welcome contributions from the community. To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/YourFeature - Make your changes and commit them:
git commit -m "feat: Add your feature" - Push to the branch:
git push origin feature/YourFeature - Open a pull request.
Please ensure your code adheres to our coding standards and includes appropriate tests.
Note: This repository uses conventional commits. Please follow the conventional commits guidelines for your commit messages.
This project is licensed under the BSD 2-Clause License. See the LICENSE file for details.