Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/v-doom/llms.txt

Use this file to discover all available pages before exploring further.

v-doom is a pre-built static React SPA — the repository itself is the deployable output. There is no package.json, no build step, and no server to configure. The React bundle, Tailwind stylesheet, and all component modules are already compiled and committed. All you need is Git and a GitHub account. Fork the repo, edit the component files to swap in your own content, push to GitHub Pages, and your portfolio is live.
1

Fork the repository

Navigate to the v-doom repository on GitHub and click Fork. Forking gives you your own copy of the repo under your account so you can push changes and deploy to your own GitHub Pages URL.Then clone your fork locally:
git clone https://github.com/YOUR_USERNAME/v-doom.git && cd v-doom
Replace YOUR_USERNAME with your GitHub username.
2

Replace the placeholder persona content

The template ships with a fictional persona — Valerius Doom, Arcane Engineer of the Digital Realm — hard-coded into the React bundle’s page components. To make the portfolio yours, edit the content strings directly in the compiled component files under /components and update the page HTML files under /pages.The key pieces to replace are:
  • Your name and tagline (home and about sections inside the bundle)
  • Your real project titles, descriptions, and links (Projects page)
  • Your actual skills and technology stack (Cauldron page)
  • Your work history and experience entries (Pacts page)
  • Your contact details and social links (Summoning page)
See the Persona Customization guide for a complete walkthrough of every field and file to update.
3

Update the page titles

Each pages/*.html file carries its own <title> tag. Open each one and update the title to reflect your name or brand:
<!-- pages/About.html — change this: -->
<title>About | v-doom</title>

<!-- to something like: -->
<title>About | Your Name</title>
Also update index.html at the repo root, which currently reads Developer Portfolio Site - Fork.
4

Commit and push your changes

Once you’ve updated your content, commit and push to the main branch (or whichever branch you prefer):
git add .
git commit -m "Replace placeholder persona with real content"
git push origin main
5

Deploy to GitHub Pages

GitHub Pages can serve your portfolio directly from any branch. Because the repository is already the compiled build output, there is no separate build step — you push the files and Pages serves them immediately.To enable GitHub Pages for your fork:
  1. Go to your repository on GitHub.
  2. Navigate to Settings → Pages.
  3. Under Build and deployment, set Source to Deploy from a branch.
  4. Select the branch you want to deploy from (e.g. main) and set the folder to / (root).
  5. Click Save.
GitHub Pages will publish your portfolio at https://YOUR_USERNAME.github.io/v-doom/. The .nojekyll file already in the repo root tells Pages to skip Jekyll processing and serve the files as-is.
The /pages/*.html files handle direct URL navigation. Each file sets window.__STATIC_PAGE_ROUTE__ and redirects the URL hash so React Router loads the correct page on a fresh visit. If you add a new route, you’ll need to create a matching pages/YourRoute.html file. See the Project Structure page for details.
The custom cursor effect works by setting cursor: none on the <body> element and rendering a Framer Motion–powered cursor in its place. For the best preview experience, use a desktop browser with a mouse — Chrome or Firefox on macOS/Windows will render the amber dot, particle trail, and click-burst sigil exactly as intended. Touch devices and some browser DevTools emulators suppress the custom cursor by default.

​
File Layout Reference

Because the repo is the build output, the files you interact with directly are:
File / DirectoryPurpose
index.htmlApp entry point — loads the React bundle and Tailwind stylesheet
pages/*.htmlOne HTML file per route — enables direct URL navigation on GitHub Pages
components/*.jsCompiled React component modules — edit these to change content and behavior
assets/main.jsBundled React application (Rollup/Vite output)
assets/main.cssTailwind CSS output
assets/proxy.jsFramer Motion m and AnimatePresence re-export
.nojekyllTells GitHub Pages to skip Jekyll and serve files directly

Build docs developers (and LLMs) love

Get started for freeTalk to us