SHOUG.TECH is my personal technical portfolio and knowledge platform, built to document and showcase my work across software engineering, cybersecurity, academic resources, workshops, and applied projects.
The platform serves as both a professional portfolio and a structured technical knowledge base, bringing together projects, coursework, security labs, documentation, study resources, and professional development in one place.
I’m Shoug Fawaz Alomran, a Software Engineering and Cybersecurity student focused on building, analyzing, securing, and documenting technical systems.
My primary areas of interest include:
- Software Engineering — designing and developing structured, maintainable software systems
- Cybersecurity — developing practical skills in penetration testing, security analysis, and defensive awareness
- Technical Documentation — transforming complex academic and technical material into structured, accessible resources
- Knowledge Systems — building platforms and workflows that organize learning, projects, and technical information
- Technical Workshops — creating and delivering practical learning experiences around development and technology
SHOUG.TECH documents that work through real projects, academic material, technical resources, workshops, and continuously evolving documentation.
- Python 3
- HTML
- CSS
- JavaScript
- MkDocs
- Material for MkDocs
- mkdocs-static-i18n
- Firebase Authentication
- Firebase
- GitHub Actions
- GitHub Pages
- Cloudflare
.
├── docs/
│ ├── academics/
│ ├── projects/
│ ├── workshops/
│ ├── resources/
│ ├── assets/
│ └── *.ar.md
│
├── scripts/
│ ├── check_i18n_parity.py
│ ├── sync_arabic.py
│ └── preflight_qa.sh
│
├── .github/
│ └── workflows/
│ └── deploy-mkdocs.yml
│
├── mkdocs.yml
└── site/
docs/— website content, academic resources, projects, assets, custom styling, scripts, and Arabic pagesmkdocs.yml— navigation, theme configuration, plugins, extensions, and internationalization settingsscripts/— validation, localization, synchronization, and pre-release QA utilities.github/workflows/deploy-mkdocs.yml— automated build and deployment workflowsite/— generated MkDocs output
Structured academic resources covering university coursework in areas including:
- Software Engineering
- Cybersecurity
- Computer Science
- Mathematics
- Supporting university courses
Course resources may include:
- Slide breakdowns
- Chapter summaries
- Mind maps
- Practice exams
- Revision material
- Study guides
- Reference resources
A professional overview of my technical work, including:
- Software projects
- Cybersecurity work
- Technical platforms
- Development experience
- Professional and academic contributions
Documentation and supporting resources for technical workshops I have developed or delivered.
A curated technical directory containing tools, references, learning platforms, development resources, cybersecurity material, and other useful links.
Background information, professional interests, technical focus areas, policies, and site information.
Clone the repository:
git clone https://github.com/Shoug-Alomran/shoug-tech.git
cd shoug-techCreate and activate a virtual environment:
python3 -m venv .venv
source .venv/bin/activateInstall the required dependencies:
pip install --upgrade pip
pip install mkdocs-material mkdocs-static-i18nStart the local development server:
mkdocs serveThe local site will typically be available at:
http://127.0.0.1:8000/
SHOUG.TECH supports both English and Arabic content using mkdocs-static-i18n.
Arabic pages follow the naming convention:
page.md
page.ar.md
Several internal utilities help maintain synchronization between both versions.
Run:
python3 scripts/check_i18n_parity.pyStrict validation:
python3 scripts/check_i18n_parity.py --strictAutomatically create placeholders for missing Arabic pages:
python3 scripts/check_i18n_parity.py --autofix-missing-arscripts/sync_arabic.py assists with synchronizing English content into formal, Saudi-friendly Arabic while preserving Markdown structure.
Dry run:
python3 scripts/sync_arabic.pyCreate missing Arabic files:
OPENAI_API_KEY=your_key python3 scripts/sync_arabic.py --applyUpdate existing Arabic files when their corresponding English content changes:
OPENAI_API_KEY=your_key python3 scripts/sync_arabic.py --apply --update-existingAdditional options include:
--backup
Creates a .bak file before overwriting existing content.
--limit N
Processes only the first N files.
--force
Ignores the translation hash cache and forces regeneration.
Before deployment, the project can be validated using:
bash scripts/preflight_qa.shThe QA process includes:
- English/Arabic parity validation
- Missing Arabic-page detection
- Strict MkDocs builds
- Clean build generation
- Theme asset validation
- Logo and favicon validation
- Route validation
- Internal-link validation
- Static-asset validation
Deployment is automated through GitHub Actions.
On pushes to the main branch, the deployment workflow:
- Installs project dependencies
- Runs English/Arabic parity checks
- Builds the MkDocs site using strict validation
- Validates generated routes
- Checks internal links and assets
- Publishes the generated site through GitHub Pages
Workflow:
.github/workflows/deploy-mkdocs.yml
The primary public domain is:
SHOUG.TECH is built around a simple principle:
Build useful systems, understand how they work, secure them where possible, and document what was learned.
The platform is designed to evolve alongside my academic, technical, and professional work rather than functioning as a static portfolio.
Copyright © 2026 Shoug Fawaz Alomran. All rights reserved.
You may:
- View and reference this repository for personal and educational purposes
- Use the published material as a learning reference with appropriate attribution
You may not:
- Reproduce or redistribute substantial portions of the repository without permission
- Republish the site's original content as your own
- Use the content commercially without prior written consent
For permissions or inquiries: