Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.59 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.59 KB

HackTheBox Writeups Template

Welcome to the HackTheBox Writeups Template! This repository is a customizable template designed for cybersecurity professionals and aspiring penetration testers to document and share their HackTheBox challenge writeups using GitHub Pages.

Check out the example site: HackTheBox Writeups Example

Features

  • Tailwind CSS for a modern and responsive design.
  • Pre-built Home, About, and Contact pages.
  • Ready-to-use writeup template for adding HackTheBox challenges writeups.
  • Easy deployment via GitHub Pages.

Installation

You can start using this template in two ways:

  1. Copy GitHub Template:

    • Click the "Use this template" button on the repository page.
    • Name your repository and clone it to your local machine.

  2. Git Clone:

    • Run the following command to clone the repository: 
      git clone https://github.com/your-username/hackthebox-writeups-template.git
cd hackthebox-writeups-template

Deployment on GitHub Pages

To deploy your writeups on GitHub Pages:

  1. Ensure the repository is public: GitHub Pages only works with public repositories.
  2. Enable GitHub Pages:
    • Go to your repository’s settings.
    • Scroll down to the "GitHub Pages" section.
    • In the "Source" dropdown, select main or master branch.
    • Your site will be live at https://<your-username>.github.io/<repository-name>/.

Future Updates

  • User comments on each writeup page for community discussions and feedback.

Stay tuned for more features!