A curated collection of CTF writeups by TeamShakti members, organized and deployable as a dynamic MkDocs-based documentation site.
CTF writeups maintained by TeamShakti members.
This repository serves as a centralized knowledge base for penetration testers, red teamers, and security enthusiasts to study and learn from past CTF challenges across various domains like crypto, forensics, pwning, reversing, and web security. Users can deploy the documentation locally or access it online to review detailed writeups and contribute new ones, aiding skill development and collaborative learning.
This repository is primarily a documentation resource rather than an executable tool; users should have Python and pip installed to set up mkdocs and its dependencies. Contributions require familiarity with markdown and the repository's folder structure. Using Docker simplifies environment setup but requires Docker installed on the host machine.
Install mkdocs via pip: pip install mkdocs
Install pymdown-extensions: pip install pymdown-extensions
Install mkdocs-material theme: pip install mkdocs-material
Install mkdocs-bootswatch theme: pip install mkdocs-bootswatch
Install mkdocs-bootstrap theme: pip install mkdocs-bootstrap
To deploy locally, run: mkdocs serve
Alternatively, use Docker: docker pull squidfunk/mkdocs-material
Run Docker container: docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-materialmkdocs serve
Starts a local development server with live reload for the documentation site
mkdocs build
Generates a static site in the 'site/' directory from the markdown files
docker pull squidfunk/mkdocs-material
Pulls the official mkdocs-material Docker image for containerized deployment
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
Runs the mkdocs-material Docker container to serve the documentation locally on port 8000