https://github.com/pardus/pardus.github.io
Pardus developers website
https://github.com/pardus/pardus.github.io
Last synced: 4 months ago
JSON representation
Pardus developers website
- Host: GitHub
- URL: https://github.com/pardus/pardus.github.io
- Owner: pardus
- Created: 2022-01-18T12:19:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T11:12:38.000Z (over 1 year ago)
- Last Synced: 2024-10-18T01:10:36.720Z (over 1 year ago)
- Language: CSS
- Homepage: https://pardus.github.io
- Size: 21.1 MB
- Stars: 4
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pardus Linux Website
This repository contains the source code for the Pardus Linux website, built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
## Getting Started
Follow these instructions to set up the project locally on your machine.
### Prerequisites
- Python 3.x
- Git
### Installation
1. **Clone the repository**
```bash
git clone git@github.com:pardus/pardus.github.io.git
cd pardus.github.io
```
2. **Create a virtual environment**
```bash
python3 -m venv venv
```
3. **Activate the virtual environment**
```bash
source venv/bin/activate
```
4. **Install dependencies**
```bash
pip install mkdocs-material mkdocs-material-extensions
```
## Usage
To start the development server with live reload:
```bash
mkdocs serve --livereload
```
Open your browser and navigate to `http://127.0.0.1:8000/`. The site will automatically update as you modify the files.
## Deployment
This project is configured to automatically deploy to GitHub Pages using GitHub Actions when changes are pushed to the `main` branch.